Upsert links library item

Base URL: https://{kibana_url}

PUT /api/links/{id}

Replaces the full state of a links library item. Partial updates are not supported. To make incremental changes, retrieve the item first, modify the fields you need, then send the complete object back.

If no item exists with the specified ID, a new one is created.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

description string
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:
tags string[] · max items: 1000 · default: []: Tag IDs associated with this library item.
title string required

Responses

updated

application/json

created

application/json

400

invalid request

403

forbidden

409

conflict

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/links/0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3
{
  "title": "Important Resources",
  "description": "A collection of important links",
  "links": [
    {
      "label": "Overview",
      "type": "dashboardLink",
      "destination": "dashboard-abc-123",
      "options": {
        "open_in_new_tab": false,
        "use_time_range": true,
        "use_filters": true
      }
    },
    {
      "label": "Elastic Documentation",
      "type": "externalLink",
      "destination": "https://www.elastic.co/docs",
      "options": {
        "encode_url": true,
        "open_in_new_tab": true
      }
    }
  ],
  "layout": "vertical"
}

curl Shell

curl \
  -X PUT "${KIBANA_URL}/api/links/0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Important Resources",
  "description": "A collection of important links",
  "links": [
    {
      "label": "Overview",
      "type": "dashboardLink",
      "destination": "dashboard-abc-123",
      "options": {
        "open_in_new_tab": false,
        "use_time_range": true,
        "use_filters": true
      }
    },
    {
      "label": "Elastic Documentation",
      "type": "externalLink",
      "destination": "https://www.elastic.co/docs",
      "options": {
        "encode_url": true,
        "open_in_new_tab": true
      }
    }
  ],
  "layout": "vertical"
}'

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/links/ID
{
  "description": "A collection of important links",
  "layout": "vertical",
  "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"
}

Generated from the API spec