> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cyrisma.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vulnerability scan dashboard for instance

> 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: access_token {token}`



## OpenAPI

````yaml openapi.json get /partner/dashboards/vulnerability
openapi: 3.1.0
info:
  title: Cyrisma Partner API
  description: >-
    Cyrisma partner API assists organizations that use the Cyrisma risk
    management platform to further automate and enhance overall risk management.
    The API provides provisioning and reporting features meaning that
    deployments can be automated and scan data can be retrieved for further
    aggregation and reporting. The API will enable the setup of new partners and
    instances, review of partner and instance status and utilization, and
    management of partners through their lifecycle.  Access to Cyrisma risk
    management is based on a foundation of secure API access token
    authentication and identity management.
  version: v1
servers: []
security: []
paths:
  /partner/dashboards/vulnerability:
    get:
      tags:
        - Dashboards
      summary: Vulnerability scan dashboard for instance
      description: "Returns vulnerability scan dashboard data for the instance associated with the access token.\r\n\r\nThe vulnerability scan dashboard includes metrics such as total vulnerability risk score, vulnerability risk grade, and breakdown of vulnerabilities by profile.\r\n\r\nRequired headers:\r\n\r\n- `Authorization: access_token {token}`"
      operationId: GetVulnScanDashboard
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardVulnerability'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
components:
  schemas:
    DashboardVulnerability:
      title: Dashboard Vulnerability
      type: object
      properties:
        current_grade:
          title: Current Grade
          type:
            - string
            - 'null'
          description: Current vulnerability grade.
        previous_grade:
          title: Previous Grade
          type:
            - string
            - 'null'
          description: Previous vulnerability grade.
        top_5_profiles:
          title: Top 5 Profiles
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/VulnerabilityProfile'
          description: List of top 5 vulnerability profiles.
        target_results:
          title: Target Results
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/SensitiveVulnTarget'
          description: List of sensitive vulnerability targets.
      additionalProperties: false
      description: >-
        Represents dashboard vulnerability data including grades, top profiles,
        and target results.
    VulnerabilityProfile:
      title: Vulnerability Profile
      type: object
      properties:
        name:
          title: Profile Name
          type:
            - string
            - 'null'
          description: Name of the vulnerability profile.
        times_used:
          title: Times Used
          type: integer
          description: Number of times the profile has been used.
          format: int32
        machines:
          title: Machines
          type: integer
          description: Number of machines associated with the profile.
          format: int32
      additionalProperties: false
      description: >-
        Represents a vulnerability profile with its name, usage frequency, and
        associated machines.
    SensitiveVulnTarget:
      title: Sensitive Vulnerability Target
      type: object
      properties:
        name:
          title: Target Name
          type:
            - string
            - 'null'
          description: Name of the sensitive vulnerability target.
        ip_address:
          title: IP Address
          type:
            - string
            - 'null'
          description: IP address of the sensitive vulnerability target.
        os:
          title: Operating System
          type:
            - string
            - 'null'
          description: Operating system of the target.
        last_scanned:
          title: Last Scanned
          type:
            - string
            - 'null'
          description: Date and time when the target was last scanned.
        vuln_count_critical:
          title: Total Scans
          type: integer
          description: Total number of scans conducted on the target.
          format: int32
        vuln_count_high:
          title: High Vulnerabilities
          type: integer
          description: Number of high severity vulnerabilities found on the target.
          format: int32
        vuln_count_medium:
          title: Medium Vulnerabilities
          type: integer
          description: Number of medium severity vulnerabilities found on the target.
          format: int32
        vuln_count_low:
          title: Low Vulnerabilities
          type: integer
          description: Number of low severity vulnerabilities found on the target.
          format: int32
      additionalProperties: false
      description: Represents a sensitive vulnerability target with its details.

````