Create a links library item

Base URL: https://{kibana_url}

POST /api/links

Creates a new links library item and returns its ID, full state, and metadata.

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>

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

created

application/json

400

invalid request

403

forbidden

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/links
{
  "summary": "Create a links library item",
  "value": {
    "title": "Important Resources",
    "description": "A collection of important links",
    "links": [
      {
        "label": "Overview",
        "type": "dashboardLink",
        "destination": "dashboard-abc-123"
      },
      {
        "label": "Elastic Documentation",
        "type": "externalLink",
        "destination": "https://www.elastic.co/docs"
      }
    ],
    "layout": "horizontal"
  }
}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/links" \
  -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"
    },
    {
      "label": "Elastic Documentation",
      "type": "externalLink",
      "destination": "https://www.elastic.co/docs"
    }
  ],
  "layout": "horizontal"
}'