Search dashboards

Base URL: https://{kibana_url}

GET /api/dashboards
GET /s/{space_id}/api/dashboards

Auth

Returns a paginated list of dashboards. Each result includes title, description, tags, and metadata, but not the full panel layout. Use GET /api/dashboards/{id} to retrieve the complete state.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

page number · min: 1 · default: 1: The page of results to return.
per_page number · min: 1 · max: 1000 · default: 20: The number of results to return per page.
query string: Filters results by title and description using Elasticsearch simple_query_string syntax. Multi-word terms require all words to match.
tags string[] · max items: 100 · default: []: A tag ID to include. Accepts a single tag ID or multiple tag IDs. When multiple are specified, library items matching any of the tag IDs are included.
excluded_tags string[] · max items: 100 · default: []: A tag ID to exclude. Accepts a single tag ID or multiple tag IDs. When multiple are specified, library items matching any of the tag IDs are excluded.
tag_names string[] · max items: 100: A tag name to include. Accepts a single tag name or multiple tag names. When multiple are specified, library items matching any of the tag names are included. If the same name is shared by multiple tags, items matching any of those tags are included.
excluded_tag_names string[] · max items: 100: A tag name to exclude. Accepts a single tag name or multiple tag names. When multiple are specified, library items matching any of the tag names are excluded. If the same name is shared by multiple tags, items matching any of those tags are excluded.

Responses

success

application/json

data object[] · max items: 1000 required: List of dashboards matching the query. Each entry includes summary fields but not the full panel layout.
meta object required

400

bad request

403

forbidden

500

internal server error

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/dashboards?query=web+logs&per_page=10

curl Shell

curl -X GET "${KIBANA_URL}/api/dashboards?query=web+logs&per_page=10" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

Paginated list of dashboard summaries. Each item includes the ID, a subset of dashboard state fields (title, time_range if set), and metadata. Full panel content is not included - use the GET endpoint to retrieve a specific dashboard.

{
  "data": [
    {
      "data": {
        "title": "Web logs overview"
      },
      "id": "3c4b8e10-d57a-11ef-9a52-4f3c2a8d0e1b",
      "meta": {
        "created_at": "2026-04-13T10:00:00.000Z",
        "managed": false,
        "updated_at": "2026-04-13T10:00:00.000Z",
        "version": "WzEwMiwxXQ=="
      }
    },
    {
      "data": {
        "time_range": {
          "from": "now-7d",
          "to": "now"
        },
        "title": "Operations overview"
      },
      "id": "7f2a1c40-e83b-11ef-a641-7d5b3f9e1c2a",
      "meta": {
        "created_at": "2026-04-12T08:00:00.000Z",
        "managed": false,
        "updated_at": "2026-04-12T14:22:00.000Z",
        "version": "WzEwMSwxXQ=="
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 2
  }
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/dashboards?tag_names=Security&tag_names=Observability

curl Shell

curl -X GET "${KIBANA_URL}/api/dashboards?tag_names=Security&tag_names=Observability" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

Paginated list of dashboard summaries. Each item includes the ID, a subset of dashboard state fields (title, time_range if set), and metadata. Full panel content is not included - use the GET endpoint to retrieve a specific dashboard.

{
  "data": [
    {
      "data": {
        "title": "Web logs overview"
      },
      "id": "3c4b8e10-d57a-11ef-9a52-4f3c2a8d0e1b",
      "meta": {
        "created_at": "2026-04-13T10:00:00.000Z",
        "managed": false,
        "updated_at": "2026-04-13T10:00:00.000Z",
        "version": "WzEwMiwxXQ=="
      }
    },
    {
      "data": {
        "time_range": {
          "from": "now-7d",
          "to": "now"
        },
        "title": "Operations overview"
      },
      "id": "7f2a1c40-e83b-11ef-a641-7d5b3f9e1c2a",
      "meta": {
        "created_at": "2026-04-12T08:00:00.000Z",
        "managed": false,
        "updated_at": "2026-04-12T14:22:00.000Z",
        "version": "WzEwMSwxXQ=="
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 2
  }
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/dashboards?excluded_tag_names=Deprecated

curl Shell

curl -X GET "${KIBANA_URL}/api/dashboards?excluded_tag_names=Deprecated" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

Paginated list of dashboard summaries. Each item includes the ID, a subset of dashboard state fields (title, time_range if set), and metadata. Full panel content is not included - use the GET endpoint to retrieve a specific dashboard.

{
  "data": [
    {
      "data": {
        "title": "Web logs overview"
      },
      "id": "3c4b8e10-d57a-11ef-9a52-4f3c2a8d0e1b",
      "meta": {
        "created_at": "2026-04-13T10:00:00.000Z",
        "managed": false,
        "updated_at": "2026-04-13T10:00:00.000Z",
        "version": "WzEwMiwxXQ=="
      }
    },
    {
      "data": {
        "time_range": {
          "from": "now-7d",
          "to": "now"
        },
        "title": "Operations overview"
      },
      "id": "7f2a1c40-e83b-11ef-a641-7d5b3f9e1c2a",
      "meta": {
        "created_at": "2026-04-12T08:00:00.000Z",
        "managed": false,
        "updated_at": "2026-04-12T14:22:00.000Z",
        "version": "WzEwMSwxXQ=="
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 2
  }
}