openapi: 3.2.0
info:
  title: Kenna Platform DASHBOARD GROUPS API
  description: OpenAPI specification for Kenna Security
  version: '1.0'
servers:
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: api.kennasecurity.com
tags:
- name: DASHBOARD GROUPS
paths:
  /dashboard_groups:
    get:
      summary: List Dashboard Groups
      description: Returns a list of all of your Dashboard Groups.
      operationId: list-dashboard-groups
      security:
      - X-Risk-Token: []
      tags:
      - DASHBOARD GROUPS
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                example_0:
                  value:
                    dashboard_groups:
                    - id: 33931
                      name: First
                      asset_search_ids:
                      - 145491
                      - 145490
                      - 145489
                      asset_search_order: default
                      client_id: 22226
                      order: 1
                      user_id: 245244
                      created_at: '2019-10-05T19:39:21.000Z'
                      updated_at: '2019-11-05T10:48:14.000Z'
                      editable: true
                      starred: false
                      share_method: not_shared
                      role_ids: []
                    - id: 33933
                      name: FIRST
                      asset_search_ids:
                      - 145487
                      - 145491
                      - 145490
                      - 145489
                      - 145691
                      asset_search_order: default
                      client_id: 22226
                      order: 1
                      user_id: 245244
                      created_at: '2019-10-05T19:42:12.000Z'
                      updated_at: '2019-11-20T23:06:34.000Z'
                      editable: true
                      starred: false
                      share_method: roles
                      role_ids:
                      - 12016
                    - id: 33934
                      name: SECOND
                      asset_search_ids:
                      - 145489
                      - 145490
                      - 145487
                      - 145491
                      asset_search_order: default
                      client_id: 22226
                      order: 2
                      user_id: 245244
                      created_at: '2019-10-05T19:42:34.000Z'
                      updated_at: '2019-10-29T18:49:01.000Z'
                      editable: true
                      starred: false
                      share_method: not_shared
                      role_ids: []
                    - id: 33935
                      name: THIRD
                      asset_search_ids:
                      - 145487
                      - 145663
                      - 145490
                      - 145555
                      asset_search_order: default
                      client_id: 22226
                      order: 3
                      user_id: 245244
                      created_at: '2019-10-05T19:43:42.000Z'
                      updated_at: '2019-11-05T10:09:27.000Z'
                      editable: true
                      starred: false
                      share_method: not_shared
                      role_ids: []
              schema:
                $ref: '#/components/schemas/dashboard_groups_get_response_schema'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                example_0: {}
              schema:
                $ref: '#/components/schemas/error_response'
    post:
      summary: Create Dashboard Group
      description: Creates a single Dashboard Group and returns the record.
      operationId: create-dashboard-group
      security:
      - X-Risk-Token: []
      tags:
      - DASHBOARD GROUPS
      parameters: []
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                example_0:
                  value:
                    id: 33931
                    name: api test 1
                    asset_search_ids:
                    - 112112
                    asset_search_order: default
                    client_id: 22226
                    order: 1
                    user_id: 245244
                    created_at: '2019-10-05T19:39:21.000Z'
                    updated_at: '2019-11-05T10:48:14.000Z'
                    editable: true
                    starred: false
                    share_method: roles
                    role_ids:
                    - 12014
              schema:
                $ref: '#/components/schemas/dashboard_groups_post_response_schema'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                example_0: {}
              schema:
                $ref: '#/components/schemas/error_response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dashboard_group_post_request_body_schema'
  /dashboard_groups/{id}:
    delete:
      summary: Delete Dashboard Group
      description: Delete a Dashboard Group using a given ID.
      operationId: delete-dashboard-group
      security:
      - X-Risk-Token: []
      tags:
      - DASHBOARD GROUPS
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: '204'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                example_0: {}
              schema:
                $ref: '#/components/schemas/error_response'
    get:
      summary: Show Dashboard Group
      description: Return information about a single Dashboard Group by ID.
      operationId: show-dashboard-group
      security:
      - X-Risk-Token: []
      tags:
      - DASHBOARD GROUPS
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                example_0:
                  value:
                    dashboard_group:
                      id: 34008
                      name: API-8
                      asset_search_ids:
                      - 145692
                      - 145490
                      asset_search_order: default
                      client_id: 22226
                      order: null
                      user_id: 245244
                      created_at: '2019-12-02T23:27:27.000Z'
                      updated_at: '2019-12-02T23:27:27.000Z'
                      editable: true
                      starred: false
                      share_method: roles
                      role_ids: []
              schema:
                $ref: '#/components/schemas/dashboard_group_get_response_schema'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                example_0: {}
              schema:
                $ref: '#/components/schemas/error_response'
    put:
      summary: Update Dashboard Group
      description: Update a single Dashboard Group's attributes by ID. Only the creator of a Dashboard Group can edit its Role IDs or Share Method.
      operationId: update-dashboard-group
      security:
      - X-Risk-Token: []
      tags:
      - DASHBOARD GROUPS
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                example_0:
                  value:
                    id: 33931
                    name: api test 1
                    asset_search_ids:
                    - 112112
                    asset_search_order: default
                    client_id: 22226
                    order: 1
                    user_id: 245244
                    created_at: '2019-10-05T19:39:21.000Z'
                    updated_at: '2019-11-05T10:48:14.000Z'
                    editable: true
                    starred: false
                    share_method: roles
                    role_ids:
                    - 12014
              schema:
                $ref: '#/components/schemas/id_put_response_schema'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                example_0: {}
              schema:
                $ref: '#/components/schemas/error_response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dashboard_group_put_request_body_schema'
components:
  schemas:
    dashboard_group_post_request_body_schema:
      type: object
      properties:
        dashboard_group:
          type: object
          properties:
            asset_search_ids:
              type: array
              default: []
              items:
                type: integer
                format: int32
            asset_search_order:
              type: string
            name:
              type: string
            role_ids:
              type: array
              default: []
              items:
                type: integer
                format: int32
            share_method:
              type: string
    error_response:
      type: object
      properties:
        error:
          type: string
          description: The HTTP error message.
        message:
          type: string
          description: The specific error message.
        success:
          type: string
          description: Indicates success, usually 'false'.
    dashboard_group_put_request_body_schema:
      type: object
      properties:
        dashboard_group:
          type: object
          properties:
            asset_search_ids:
              type: array
              default: []
              items:
                type: integer
                format: int32
            asset_search_order:
              type: string
            name:
              type: string
            role_ids:
              type: array
              description: Can only be updated by the creator of the Dashboard Group
              default: []
              items:
                type: integer
                format: int32
            share_method:
              type: string
              description: Can only be updated by the creator of the Dashboard Group
    dashboard_groups_post_response_schema:
      type: integer
      example: 33931
      default: 0
    id_put_response_schema:
      type: integer
      example: 33931
      default: 0
    dashboard_group_get_response_schema:
      type: object
      properties:
        id:
          type: integer
          example: 34008
          default: 0
        name:
          type: string
          example: API-8
        asset_search_ids:
          type: array
          items:
            type: integer
            example: 145692
            default: 0
        asset_search_order:
          type: string
          example: default
        client_id:
          type: integer
          example: 22226
          default: 0
        order: {}
        user_id:
          type: integer
          example: 245244
          default: 0
        created_at:
          type: string
          example: '2019-12-02T23:27:27.000Z'
        updated_at:
          type: string
          example: '2019-12-02T23:27:27.000Z'
        editable:
          type: boolean
          example: true
          default: true
        starred:
          type: boolean
          example: false
          default: true
        share_method:
          type: string
          example: roles
        role_ids:
          type: array
          items:
            type: integer
    dashboard_groups_get_response_schema:
      type: array
      items:
        type: object
        properties:
          id:
            type: integer
            example: 33931
            default: 0
          name:
            type: string
            example: First
          asset_search_ids:
            type: array
            items:
              type: integer
              example: 145491
              default: 0
          asset_search_order:
            type: string
            example: default
          client_id:
            type: integer
            example: 22226
            default: 0
          order:
            type: integer
            example: 1
            default: 0
          user_id:
            type: integer
            example: 245244
            default: 0
          created_at:
            type: string
            example: '2019-10-05T19:39:21.000Z'
          updated_at:
            type: string
            example: '2019-11-05T10:48:14.000Z'
          editable:
            type: boolean
            example: true
            default: true
          starred:
            type: boolean
            example: false
            default: true
          share_method:
            type: string
            example: not_shared
          role_ids:
            type: array
            items:
              type: integer
  securitySchemes:
    X-Risk-Token:
      type: apiKey
      name: X-Risk-Token
      in: header
x-provenance:
  method: searched
  source: https://apidocs.kennasecurity.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://apidocs.kennasecurity.com/reference/add-applications-to-role.md
  - https://apidocs.kennasecurity.com/reference/add-asset-groups-to-role.md
  - https://apidocs.kennasecurity.com/reference/application-findings-historical-mean-time-to-remediate-by-risk-level.md
  - https://apidocs.kennasecurity.com/reference/application-historical-mean-time-to-remediate-by-risk-level.md
  - https://apidocs.kennasecurity.com/reference/application-historical-vulnerability-count-by-risk-level.md
  - https://apidocs.kennasecurity.com/reference/asset-groups-findings-historical-mean-time-to-remediate-by-risk-level.md
  - https://apidocs.kennasecurity.com/reference/audit-log-search.md
  - https://apidocs.kennasecurity.com/reference/average-days-open-by-risk-level-over-time.md
  - https://apidocs.kennasecurity.com/reference/bulk-delete-findings.md
  - https://apidocs.kennasecurity.com/reference/bulk-delete-vulnerabilities.md
  - https://apidocs.kennasecurity.com/reference/bulk-update-assets.md
  - https://apidocs.kennasecurity.com/reference/bulk-update-vulnerability.md
  - https://apidocs.kennasecurity.com/reference/calculate-asset-group-metric.md
  - https://apidocs.kennasecurity.com/reference/check-data-export-status.md
  - https://apidocs.kennasecurity.com/reference/check-remediation-score.md
  - https://apidocs.kennasecurity.com/reference/check-sla-adherence-metrics.md
  - https://apidocs.kennasecurity.com/reference/check-vulnerability-densities-metrics.md
  - https://apidocs.kennasecurity.com/reference/create-application.md
  - https://apidocs.kennasecurity.com/reference/create-asset-group-and-risk-meter.md
  - https://apidocs.kennasecurity.com/reference/create-asset.md
  - https://apidocs.kennasecurity.com/reference/create-child-asset-group-and-risk-meter.md
  - https://apidocs.kennasecurity.com/reference/create-dashboard-group.md
  - https://apidocs.kennasecurity.com/reference/create-finding.md
  - https://apidocs.kennasecurity.com/reference/create-role.md
  - https://apidocs.kennasecurity.com/reference/create-stack.md
  - https://apidocs.kennasecurity.com/reference/create-user.md
  - https://apidocs.kennasecurity.com/reference/create-vulnerability.md
  - https://apidocs.kennasecurity.com/reference/delete-application.md
  - https://apidocs.kennasecurity.com/reference/delete-asset-group.md
  - https://apidocs.kennasecurity.com/reference/delete-dashboard-group.md
  - https://apidocs.kennasecurity.com/reference/delete-role.md
  - https://apidocs.kennasecurity.com/reference/delete-stack.md
  - https://apidocs.kennasecurity.com/reference/delete-user.md
  - https://apidocs.kennasecurity.com/reference/delete-vulnerability.md
  - https://apidocs.kennasecurity.com/reference/download-zipped-asset-data.md
  - https://apidocs.kennasecurity.com/reference/download-zipped-vuln-data.md
  - https://apidocs.kennasecurity.com/reference/entitlements-overage.md
  - https://apidocs.kennasecurity.com/reference/false-positive-by-risk-level-over-time.md
  - https://apidocs.kennasecurity.com/reference/get-refresh-reporting-status.md
  - https://apidocs.kennasecurity.com/reference/historical-mean-time-to-remediate-by-risk-level.md
  - https://apidocs.kennasecurity.com/reference/historical-risk-meter-scores.md
  - https://apidocs.kennasecurity.com/reference/historical-vulnerability-risk-category-counts.md
  - https://apidocs.kennasecurity.com/reference/kill-running-data-export.md
  - https://apidocs.kennasecurity.com/reference/list-applications.md
  - https://apidocs.kennasecurity.com/reference/list-asset-groups.md
  - https://apidocs.kennasecurity.com/reference/list-assets.md
  - https://apidocs.kennasecurity.com/reference/list-connector-runs.md
  - https://apidocs.kennasecurity.com/reference/list-connectors.md
  - https://apidocs.kennasecurity.com/reference/list-cve-identifiers.md
  - https://apidocs.kennasecurity.com/reference/list-dashboard-groups.md
  - https://apidocs.kennasecurity.com/reference/list-fix-alternatives.md
  - https://apidocs.kennasecurity.com/reference/list-fixes.md
  - https://apidocs.kennasecurity.com/reference/list-roles.md
  - https://apidocs.kennasecurity.com/reference/list-stacks.md
  - https://apidocs.kennasecurity.com/reference/list-tags.md
  - https://apidocs.kennasecurity.com/reference/list-users.md
  - https://apidocs.kennasecurity.com/reference/list-vulnerabilities.md
  - https://apidocs.kennasecurity.com/reference/list-vulnerability-definitions.md
  - https://apidocs.kennasecurity.com/reference/past-due-vulnerabilities-by-risk-level-over-time.md
  - https://apidocs.kennasecurity.com/reference/refresh-reporting-data.md
  - https://apidocs.kennasecurity.com/reference/request-data-export.md
  - https://apidocs.kennasecurity.com/reference/retrieve-data-export.md
  - https://apidocs.kennasecurity.com/reference/risk-accepted-by-risk-level-over-time.md
  - https://apidocs.kennasecurity.com/reference/run-connector.md
  - https://apidocs.kennasecurity.com/reference/search-assets.md
  - https://apidocs.kennasecurity.com/reference/search-findings.md
  - https://apidocs.kennasecurity.com/reference/search-fixes.md
  - https://apidocs.kennasecurity.com/reference/search-for-vulnerability-definitions.md
  - https://apidocs.kennasecurity.com/reference/search-users.md
  - https://apidocs.kennasecurity.com/reference/search-vulnerabilities.md
  - https://apidocs.kennasecurity.com/reference/service-now-list-fixes.md
  - https://apidocs.kennasecurity.com/reference/service-now-search-vulnerabilities.md
  - https://apidocs.kennasecurity.com/reference/show-all-fixes.md
  - https://apidocs.kennasecurity.com/reference/show-application.md
  - https://apidocs.kennasecurity.com/reference/show-asset-group.md
  - https://apidocs.kennasecurity.com/reference/show-asset-vulnerabilities.md
  - https://apidocs.kennasecurity.com/reference/show-asset.md
  - https://apidocs.kennasecurity.com/reference/show-chatter.md
  - https://apidocs.kennasecurity.com/reference/show-connector-run.md
  - https://apidocs.kennasecurity.com/reference/show-cve-history.md
  - https://apidocs.kennasecurity.com/reference/show-dashboard-group.md
  - https://apidocs.kennasecurity.com/reference/show-finding.md
  - https://apidocs.kennasecurity.com/reference/show-fix.md
  - https://apidocs.kennasecurity.com/reference/show-malware-hashes.md
  - https://apidocs.kennasecurity.com/reference/show-role.md
  - https://apidocs.kennasecurity.com/reference/show-scanner-vulnerability-details.md
  - https://apidocs.kennasecurity.com/reference/show-stack.md
  - https://apidocs.kennasecurity.com/reference/show-top-fix-groups.md
  - https://apidocs.kennasecurity.com/reference/show-user.md
  - https://apidocs.kennasecurity.com/reference/show-vulnerability-definition.md
  - https://apidocs.kennasecurity.com/reference/show-vulnerability.md
  - https://apidocs.kennasecurity.com/reference/stack-applications-statistics.md
  - https://apidocs.kennasecurity.com/reference/stack-asset-groups-statistics.md
  - https://apidocs.kennasecurity.com/reference/tag-an-asset.md
  - https://apidocs.kennasecurity.com/reference/total-past-due-vulnerabilities-by-risk-level.md
  - https://apidocs.kennasecurity.com/reference/trends.md
  - https://apidocs.kennasecurity.com/reference/untag-an-asset.md
  - https://apidocs.kennasecurity.com/reference/update-application.md
  - https://apidocs.kennasecurity.com/reference/update-asset-group.md
  - https://apidocs.kennasecurity.com/reference/update-asset.md
  - https://apidocs.kennasecurity.com/reference/update-connector.md
  - https://apidocs.kennasecurity.com/reference/update-dashboard-group.md
  - https://apidocs.kennasecurity.com/reference/update-findings.md
  - https://apidocs.kennasecurity.com/reference/update-permissions-in-bulk.md
  - https://apidocs.kennasecurity.com/reference/update-role-custom-permissions.md
  - https://apidocs.kennasecurity.com/reference/update-role.md
  - https://apidocs.kennasecurity.com/reference/update-stack.md
  - https://apidocs.kennasecurity.com/reference/update-user.md
  - https://apidocs.kennasecurity.com/reference/update-vulnerability.md
  - https://apidocs.kennasecurity.com/reference/upload-data-file.md
  - https://apidocs.kennasecurity.com/reference/validate-asset-search-query.md
  - https://apidocs.kennasecurity.com/reference/validate-vulnerability-search-query.md
  - https://apidocs.kennasecurity.com/reference/vi-data-snapshot.md
  - https://apidocs.kennasecurity.com/reference/vulnerabilities-by-due-date.md
  - https://apidocs.kennasecurity.com/reference/vulnerability-definitions-with-significant-score-change.md
  merge:
    pages: 115
    deduped: 272
    conflicts_kept_first: 0