Elastic Stack (ELK Stack) Dashboards API

openapi: 3.2.0
info:
  contact:
    name: Kibana Team
  description: The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
  title: Kibana Dashboards API
  version: ''
  x-doc-license:
    name: Attribution-NonCommercial-NoDerivatives 4.0 International
    url: https://creativecommons.org/licenses/by-nc-nd/4.0/
  x-feedbackLink:
    label: Feedback
    url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
  variables:
    kibana_url:
      default: localhost:5601
security:
- apiKeyAuth: []
- basicAuth: []
tags:
- name: Dashboards
  description: '> This documentation is temporarily hosted at a separate location.

    >

    > **View the full Dashboards API reference →**'
  externalDocs:
    description: Dashboards documentation
    url: https://www.elastic.co/docs/explore-analyze/dashboards
  x-displayName: Dashboards
paths:
  /api/dashboards:
    get:
      tags:
      - Dashboards
      summary: Search dashboards
      operationId: search-dashboards
      description: '> This documentation is temporarily hosted at a separate location.

        >

        > **View the full Dashboards API reference →**'
      responses:
        '200':
          description: See the full Dashboards API reference for detailed response schemas.
    post:
      tags:
      - Dashboards
      summary: Create a dashboard
      operationId: create-dashboard
      description: '> This documentation is temporarily hosted at a separate location.

        >

        > **View the full Dashboards API reference →**'
      responses:
        '200':
          description: See the full Dashboards API reference for detailed response schemas.
  /api/dashboards/{id}:
    get:
      tags:
      - Dashboards
      summary: Get a dashboard
      operationId: get-dashboard
      description: '> This documentation is temporarily hosted at a separate location.

        >

        > **View the full Dashboards API reference →**'
      responses:
        '200':
          description: See the full Dashboards API reference for detailed response schemas.
    put:
      tags:
      - Dashboards
      summary: Upsert a dashboard
      operationId: upsert-dashboard
      description: '> This documentation is temporarily hosted at a separate location.

        >

        > **View the full Dashboards API reference →**'
      responses:
        '200':
          description: See the full Dashboards API reference for detailed response schemas.
    delete:
      tags:
      - Dashboards
      summary: Delete a dashboard
      operationId: delete-dashboard
      description: '> This documentation is temporarily hosted at a separate location.

        >

        > **View the full Dashboards API reference →**'
      responses:
        '200':
          description: See the full Dashboards API reference for detailed response schemas.
components:
  securitySchemes:
    apiKeyAuth:
      description: 'These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: `Authorization: ApiKey base64AccessApiKey`

        '
      in: header
      name: Authorization
      type: apiKey
    basicAuth:
      scheme: basic
      type: http
x-topics:
- title: Kibana spaces
  content: "Spaces enable you to organize your dashboards and other saved objects into meaningful categories.\nYou can use the default space or create your own spaces.\n\nTo run APIs in non-default spaces, you must add `s/{space_id}/` to the path.\nFor example:\n\n```bash\ncurl -X GET \"http://${KIBANA_URL}/s/marketing/api/data_views\" \\\n  -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nIf you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.\n\nTo learn more, check out [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces).\n"