Get a links library item by ID | Kibana API documentation

Get a links library item by ID Experimental; added in 9.6.0

GET /api/links/{id}

Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/links/{id}

Refer to Spaces for more information.

Returns the complete state of a links library item by ID.

Path parameters

id string Required

The unique ID of the links library item, as returned by the create or search endpoints.

Maximum length is 250.

Responses

200 application/json

success
Hide response attributes Show response attributes object
- data object Required
  
  Additional properties are NOT allowed.
  
  Hide data attributes Show data attributes object
  
  description string
  
  layout string
  
  Whether to display the links in a horizontal or vertical layout.
  
  Values are horizontal or vertical.
  
  links array[object] Required
  
  The list of links to display.
  
  Not more than 100 elements.
  
  One of:
  dashboardLink object externalLink object
  
  Link type. Set to dashboardLink for a link to another dashboard.
  
  Hide attributes Show attributes
  
  destination string Required
  
  Linked dashboard saved object ID.
  
  label string
  
  The label of the link displayed in the UI.
  
  options object
  
  Default value is {"open_in_new_tab" => false, "use_filters" => true, "use_time_range" => true}. Additional properties are NOT allowed.
  
  Hide options attributes Show options attributes object
  
  open_in_new_tab boolean
  
  When enabled, the dashboard opens in a new browser tab.
  
  Default value is false.
  
  use_filters boolean
  
  When enabled, filters are passed to the opening dashboard.
  
  Default value is true.
  
  use_time_range boolean
  
  When enabled, time range is passed to the opening dashboard.
  
  Default value is true.
  
  type string Required Discriminator
  
  Value is dashboardLink.
  
  Link type. Set to externalLink for a URL outside Kibana.
  
  Hide attributes Show attributes
  
  destination string Required
  
  The external URL to link to.
  
  label string
  
  The label of the link displayed in the UI.
  
  options object
  
  Default value is {"encode_url" => true, "open_in_new_tab" => true}. Additional properties are NOT allowed.
  
  Hide options attributes Show options attributes object
  
  encode_url boolean
  
  Whether to escape the URL with percent encoding
  
  Default value is true.
  
  open_in_new_tab boolean
  
  Whether to open this link in a new tab when clicked.
  
  Default value is true.
  
  type string Required Discriminator
  
  Value is externalLink.
  
  tags array[string]
  
  Tag IDs associated with this library item.
  
  Not more than 1000 elements. Maximum length of each is 250. Default value is [] (empty).
  
  title string Required
- id string Required
  
  The unique ID of the links library item, as returned by the create or search endpoints.
  
  Maximum length is 250.
- meta object Required
  
  Additional properties are NOT allowed.
  
  Hide meta attributes Show meta attributes object
  
  created_at string
  
  Timestamp when the object was created (ISO 8601).
  
  created_by string
  
  User profile ID of the user who created the object.
  
  managed boolean
  
  When true, the object is managed by Kibana and cannot be edited by users.
  
  owner string
  
  Identifier of the plugin or team that owns this object.
  
  updated_at string
  
  Timestamp when the object was last updated (ISO 8601).
  
  updated_by string
  
  User profile ID of the user who last updated the object.
  
  version string
  
  Internal version identifier for optimistic concurrency control.
403

forbidden
404

A links library item with the given ID was not found.

GET /api/links/{id}

curl -X GET "${KIBANA_URL}/api/links/0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3" \
  -H "Authorization: ApiKey ${API_KEY}"

GET kbn:/api/links/0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3

Response examples (200)

The full links library item state including `links`, `layout`, `title`, `description`, and metadata.

{
  "data": {
    "description": "A collection of important links",
    "layout": "horizontal",
    "links": [
      {
        "destination": "dashboard-abc-123",
        "label": "Overview",
        "options": {
          "open_in_new_tab": false,
          "use_filters": true,
          "use_time_range": true
        },
        "type": "dashboardLink"
      },
      {
        "destination": "https://www.elastic.co/docs",
        "label": "Elastic Documentation",
        "options": {
          "encode_url": true,
          "open_in_new_tab": true
        },
        "type": "externalLink"
      }
    ],
    "title": "Important Resources"
  },
  "id": "0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3",
  "meta": {
    "created_at": "2026-04-13T10:00:00.000Z",
    "managed": false,
    "updated_at": "2026-04-13T10:00:00.000Z",
    "version": "WzU5LDFd"
  }
}