Upsert links library item

Server: https://{kibana_url}

PUT /api/links/{id}

Api key auth Basic auth

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.

Path Parameters

id string required: The unique ID of the links library item to be created or updated

Request

Responses

updated

application/json

created

application/json

400

invalid request

403

forbidden

409

conflict

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"
}

curl Shell

curl \
  -X PUT "${KIBANA_URL}/api/links/{id}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "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"
}'

Response

{
  "data": {
    "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"
  },
  "id": "0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3",
  "meta": {
    "created_at": "2026-04-13T10:00:00.000Z",
    "managed": false,
    "updated_at": "2026-04-13T11:00:00.000Z",
    "version": "WzYwLDFd"
  }
}

{
  "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"
  }
}