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.

    The API calls are stateless.

    Each request that you make happens in isolation from other calls and must include all of the necessary information for Kibana to fulfill the

    request.

    API requests return JSON output, which is a format that is machine-readable and works well for automation.


    To interact with Kibana APIs, use the following operations:


    - GET: Fetches the information.

    - PATCH: Applies partial modifications to the existing information.

    - POST: Adds new information.

    - PUT: Updates the existing information.

    - DELETE: Removes the information.


    You can prepend any Kibana API endpoint with `kbn:` and run the request in **Dev Tools → Console**.

    For example:


    ```

    GET kbn:/api/data_views

    ```


    For more information about the console, refer to [Run API requests](https://www.elastic.co/docs/explore-analyze/query-filter/tools/console).


    NOTE: Access to internal Kibana API endpoints will be restricted in Kibana version 9.0. Please move any integrations to publicly documented APIs.


    ## Documentation source and versions


    This documentation is derived from the `main` branch of the [kibana](https://github.com/elastic/kibana) repository.

    It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).


    This documentation contains work-in-progress information for future Elastic Stack releases.

    '
  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 →](https://elastic.github.io/dashboards-api-spec/dashboards#tag/Dashboards)**

    '
  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 →](https://elastic.github.io/dashboards-api-spec/dashboards#tag/Dashboards)**

        '
      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 →](https://elastic.github.io/dashboards-api-spec/dashboards#tag/Dashboards)**

        '
      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 →](https://elastic.github.io/dashboards-api-spec/dashboards#tag/Dashboards)**

        '
      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 →](https://elastic.github.io/dashboards-api-spec/dashboards#tag/Dashboards)**

        '
      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 →](https://elastic.github.io/dashboards-api-spec/dashboards#tag/Dashboards)**

        '
      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"