List links library items
https://{kibana_url}
- GET /api/links
- GET /s/{space_id}/api/links
Refer to Spaces for more information.
Returns a paginated list of links library items. Each result includes title, description, and metadata. Use GET /api/links/{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 · min: 0 · max: 1000required -
List of links library items matching the query.
-
dataobjectrequired -
descriptionstring · max: 10000 -
A short description of the links library item.
-
titlestring · max: 1000required -
The links library item title.
-
idstring · max: 250required -
meta -
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.
forbidden