Get a links library item by ID
Base URL
https://{kibana_url}
Auth
Stack
Planned
The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.
Availability
Planned
We plan to add this functionality in a future Elastic Stack update. Subject to changes.
Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.
This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Returns the complete state of a links library item by ID.
Expand all
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.
id
string · max length: 250 required
The unique ID of the links library item, as returned by the create or search endpoints.
data
object required
−
Hide 5 properties
layout
enum
Whether to display the links in a horizontal or vertical layout.
Values:
horizontal
vertical
links
union oneOf [] · max items: 100 required
The list of links to display.
One of:
Link type. Set to dashboardLink for a link to another dashboard.
−
Hide 4 properties
type
enum required
Values:
dashboardLink
destination
string required
Linked dashboard saved object ID.
label
string
The label of the link displayed in the UI.
options
object
Default:
{"open_in_new_tab":false,"use_filters":true,"use_time_range":true}
+
Show 3 properties
open_in_new_tab
boolean · default: false
When enabled, the dashboard opens in a new browser tab.
use_filters
boolean · default: true
When enabled, filters are passed to the opening dashboard.
use_time_range
boolean · default: true
When enabled, time range is passed to the opening dashboard.
Link type. Set to externalLink for a URL outside Kibana.
−
Hide 4 properties
type
enum required
Values:
externalLink
destination
string required
The external URL to link to.
label
string
The label of the link displayed in the UI.
options
object
Default:
{"encode_url":true,"open_in_new_tab":true}
+
Show 2 properties
encode_url
boolean · default: true
Whether to escape the URL with percent encoding
open_in_new_tab
boolean · default: true
Whether to open this link in a new tab when clicked.
tags
string [] · max items: 1000 · default: []
Tag IDs associated with this library item.
id
string · max length: 250 required
The unique ID of the links library item, as returned by the create or search endpoints.
meta
object required
−
Hide 7 properties
404
A links library item with the given ID was not found.