# Cyrisma Documentation ## Docs - [Authentication](https://docs.cyrisma.com/api-reference/authentication.md): Learn how to authenticate with the Cyrisma Partner API - [CVE information for instance](https://docs.cyrisma.com/api-reference/dashboards/cve-information-for-instance.md): Returns CVE information for the instance associated with the access token. The CVE information includes details such as CVE ID, description, severity, affected assets, and remediation steps. Required headers: - `Authorization: access_token {token}` - [Data scan dashboard for instance](https://docs.cyrisma.com/api-reference/dashboards/data-scan-dashboard-for-instance.md): Returns data scan dashboard data for the instance associated with the access token. The data scan dashboard includes metrics such as total data risk score, data risk grade, and breakdown of data risks by category. Required headers: - `Authorization: access_token {token}` - [Overall risk dashboard for instance](https://docs.cyrisma.com/api-reference/dashboards/overall-risk-dashboard-for-instance.md): Returns overall risk dashboard data for the instance associated with the access token. The overall risk dashboard includes metrics such as total risk score, risk grade, and breakdown of risks by category. In the output, the respective grades are represented by scan type. There is Current and P… - [Secure Baseline scan dashboard for instance](https://docs.cyrisma.com/api-reference/dashboards/secure-baseline-scan-dashboard-for-instance.md): Returns secure baseline scan dashboard data for the instance associated with the access token. The secure baseline scan dashboard includes metrics such as total baseline risk score, baseline risk grade, and breakdown of baseline risks by profile. Required headers: - `Authorization: access_t… - [Vulnerability scan dashboard for instance](https://docs.cyrisma.com/api-reference/dashboards/vulnerability-scan-dashboard-for-instance.md): Returns vulnerability scan dashboard data for the instance associated with the access token. The vulnerability scan dashboard includes metrics such as total vulnerability risk score, vulnerability risk grade, and breakdown of vulnerabilities by profile. Required headers: - `Authorization: a… - [Getting Started](https://docs.cyrisma.com/api-reference/getting-started.md): Get started with the Cyrisma Partner API - [Convert Consulting To Standard Endpoint](https://docs.cyrisma.com/api-reference/instances/convert-consulting-to-standard-endpoint.md): This endpoint will convert a consulting instance to a standard instance under your partner account. **Note:** - Conversion from Consulting to Managed is a one way operation. Managed instances cannot be converted back to consulting. Required headers: - `Authorization: access_token {token… - [Convert Consulting To Standard Endpoint](https://docs.cyrisma.com/api-reference/instances/convert-consulting-to-standard-endpoint-1.md): This endpoint will convert a consulting instance to a standard instance under your partner account. Required headers: - `Authorization: access_token {token}` - [Create Instance User Endpoint](https://docs.cyrisma.com/api-reference/instances/create-instance-user-endpoint.md): This endpoint will create a new user under a specific subordinate instance within your partner account. Required headers: - `Authorization: access_token {token}` - [Create Instances Endpoint](https://docs.cyrisma.com/api-reference/instances/create-instances-endpoint.md): This endpoint will provision a new instance under your partner account. It is important to understand the hierarchy of the organizations set up under the CYRISMA Web platform. Instances can be created under existing organizations or sub organizations, or new sub organizations can be created.… - [Get Instances Endpoint](https://docs.cyrisma.com/api-reference/instances/get-instances-endpoint.md): This will retrieve the entire existing provisioned structure of organizations and instances within the CYRISMA platform. Required headers: - `Authorization: access_token {token}` - [Get Instances Endpoint](https://docs.cyrisma.com/api-reference/instances/get-instances-endpoint-1.md): This will retrieve the entire existing provisioned structure of organizations and instances within the CYRISMA platform. Required headers: - `Authorization: access_token {token}` - [Reactivate Instance Endpoint](https://docs.cyrisma.com/api-reference/instances/reactivate-instance-endpoint.md): This endpoint will reactivate a suspended instance under your partner account. Required headers: - `Authorization: access_token {token}` - [Suspend Instance Endpoint](https://docs.cyrisma.com/api-reference/instances/suspend-instance-endpoint.md): This endpoint will suspend an instance under your partner account. **Notes:** - Suspended instances are NOT visible within the MSP web interface. - Suspended instances are not shown in the API “Get All” request. - To restore a suspended instance or organization, the instanceID is required,… - [Partner Login Endpoint](https://docs.cyrisma.com/api-reference/login/partner-login-endpoint.md): Endpoint for partners to login and receive an access token. The 'grant_type' key indicates this is a password request in compliance with OAuth 2.0 principles. The access token is important and is used to continue all future interaction with the API. The optional refresh token is used to r… - [Reset Password Endpoint](https://docs.cyrisma.com/api-reference/login/reset-password-endpoint.md): First-time API use should always begin with password reset. Please reset the original temporary password so that only YOUR authorized applications have access to the API. **NOTE:** This password is your API secret password and is only returned here **one time**. Cyrisma only stores an encrypted… - [Completed scans for instance](https://docs.cyrisma.com/api-reference/scans/completed-scans-for-instance.md): Returns completed scans for the instance associated with the access token. Each completed scan returned by the API includes information such as scan ID, target name, scan status, start and end times, and summary of findings. Required headers: - `Authorization: access_token {token}` - [Data scans for instance](https://docs.cyrisma.com/api-reference/scans/data-scans-for-instance.md): Returns data scans for the instance associated with the access token. Each data scan returned by the API includes information such as scan ID, target name, scan status, start and end times, and summary of findings. Required headers: - `Authorization: access_token {token}` - [Secure Baseline scans for instance](https://docs.cyrisma.com/api-reference/scans/secure-baseline-scans-for-instance.md): Returns secure baseline scans for the instance associated with the access token. Each secure baseline scan returned by the API includes information such as scan ID, target name, scan status, start and end times, and summary of findings. Required headers: - `Authorization: access_token {toke… - [Vulnerability for scan Id](https://docs.cyrisma.com/api-reference/scans/vulnerability-for-scan-id.md): Returns asets with asset vulnerabilities. Each asset returned by the API may include three collections: **vulnerabilities**, **openPorts**, and **flaws**. These collections are populated based on the **scan type**, as follows: - Internal Authenticated (scan type 5), Internal Unauthenticated (sca… - [Vulnerability scans for instance](https://docs.cyrisma.com/api-reference/scans/vulnerability-scans-for-instance.md): Returns vulnerability scans for the instance associated with the access token. Each vulnerability scan returned by the API includes information such as scan ID, target name, scan status, start and end times, and summary of findings. Required headers: - `Authorization: access_token {token}` - [Disable User Endpoint](https://docs.cyrisma.com/api-reference/users/disable-user-endpoint.md): This endpoint will disable a user under your partner account. Required headers: - `Authorization: access_token {token}` - [Get User Endpoint](https://docs.cyrisma.com/api-reference/users/get-user-endpoint.md): This endpoint will retrieve information about a single user under your partner account. **Note:** - Users MUST be added to instance_ids that are organizations. You cannot add a user to an instance_id that is a standard, trial or consulting instance. Required headers: - `Authorization:… - [Get Users Endpoint](https://docs.cyrisma.com/api-reference/users/get-users-endpoint.md): This endpoint will retrieve a list of users under your partner account. Required headers: - `Authorization: access_token {token}` - [Assets list with vulnerability counts](https://docs.cyrisma.com/api-reference/vulnerability-assets/assets-list-with-vulnerability-counts.md): Returns a list of assets and their vulnerability totals (critical/high/medium/low/info), along with basic asset metadata. Required headers: - `Authorization: access_token {token}` - [Internal Authenticated scan details for an asset](https://docs.cyrisma.com/api-reference/vulnerability-assets/internal-authenticated-scan-details-for-an-asset.md): Returns **Internal Authenticated** vulnerability details for a single asset based on asset id. Use this endpoint when you already know the asset id and want detailed counts and list of **root cause**s, **CVE**s and **open ports** for the asset. Required headers: - `Authorization: access_tok… - [Internal Unauthenticated/External - IP Addresses scan details for an asset](https://docs.cyrisma.com/api-reference/vulnerability-assets/internal-unauthenticatedexternal--ip-addresses-scan-details-for-an-asset.md): Returns **Internal Unauthenticated** or **External IP Address** vulnerability details for a device identified by IP address, based asset IP address. Use this endpoint when you already know the asset ip and want detailed counts and list of **CVE**s and **open ports** for the asset. Required hea… - [Web Application scan findings for an asset](https://docs.cyrisma.com/api-reference/vulnerability-assets/web-application-scan-findings-for-an-asset.md): Returns **web application** vulnerability findings (for example: URL-based issues) for a specific asset. Use this endpoint when you already know the asset id and want detailed counts and list of **findings** for the asset. Required headers: - `Authorization: access_token {token}` ## OpenAPI Specs - [openapi](https://docs.cyrisma.com/openapi.json)