List links library items

Base URL: https://{kibana_url}

GET /api/links

Returns a paginated list of links library items. Each result includes title, description, and metadata. Use GET /api/links/{id} to retrieve the complete state.

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>

Query parameters

Responses

success

application/json

403

forbidden

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/links?query=welcome&per_page=10

curl Shell

curl -X GET "${KIBANA_URL}/api/links?query=welcome&per_page=10" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

Returns a paginated list of links library items. Each result includes title, description, and metadata. Use GET /api/links/{id} to retrieve the complete state.

{
  "data": [
    {
      "data": {
        "description": "A collection of important links",
        "title": "Important Resources"
      },
      "id": "0ee9d0ea-06a0-4a30-bf4e-be4d3ca85bf3",
      "meta": {
        "created_at": "2026-06-03T23:33:39.979Z",
        "created_by": "u_EWATCHX9oIEsmcXj8aA1FkcaY3DE-XEpsiGTjrR2PmM_0",
        "managed": false,
        "updated_at": "2026-06-03T23:33:39.979Z",
        "updated_by": "u_EWATCHX9oIEsmcXj8aA1FkcaY3DE-XEpsiGTjrR2PmM_0",
        "version": "WzEwNywxXQ=="
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}