Search dashboards
https://{kibana_url}
- GET /api/dashboards
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.
Query Parameters
-
pagenumber · min: 1 · default: 1 The page of results to return.
-
per_pagenumber · min: 1 · max: 1000 · default: 20 The number of results to return per page.
-
querystring Filters results by
titleanddescriptionusing Elasticsearchsimple_query_stringsyntax. Multi-word terms require all words to match.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.
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_namesstring · max: 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_namesstring · max: 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
-
dataobject · max: 1000required -
List of dashboards matching the query. Each entry includes summary fields but not the full panel layout.
-
dataobjectrequired -
access_control -
Access control settings for the dashboard.
-
access_mode -
Controls edit access to the dashboard. Set to
write_restrictedto prevent edits by users without explicit write permission. Defaults todefault(all viewers can edit). -
Values:
write_restricteddefault -
descriptionstring -
A short description of the dashboard.
-
Tag IDs associated with this dashboard.
-
time_range -
Specifies the time range for a query.
-
titlestringrequired -
The dashboard title.
-
idstringrequired -
The dashboard ID.
-
metarequired -
created_atstring -
Timestamp when the object was created (ISO 8601).
-
created_bystring -
User profile ID of the user who created the object.
-
managedboolean -
When
true, the object is managed by Kibana and cannot be edited by users. -
ownerstring -
Identifier of the plugin or team that owns this object.
-
updated_atstring -
Timestamp when the object was last updated (ISO 8601).
-
updated_bystring -
User profile ID of the user who last updated the object.
-
versionstring -
Internal version identifier for optimistic concurrency control.
bad request
forbidden
internal server error