Get a short URL

Base URL: https://{kibana_url}

GET /api/short_url/{id}

Auth

Get a single Kibana short URL.

Path parameters

id string required: The identifier for the short URL.

Response

Indicates a successful call.

application/json

accessCount integer: Number of times the short URL has been resolved.
accessDate integer · format: int64: Unix epoch (milliseconds) of the last time the short URL was resolved. Set to the creation time when the URL has never been accessed.
createDate integer · format: int64: Unix epoch (milliseconds) when the short URL was created.
id string: The identifier for the short URL.
locator object
slug string: A random human-readable slug is automatically generated if the humanReadableSlug parameter is set to true. If it is set to false, a random short string is generated.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/short_url/ID

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/short_url/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The short URL record matching the given identifier.

{
  "accessCount": 12,
  "accessDate": 1767744000000,
  "createDate": 1767225600000,
  "id": "c54b04f5d4b3aa3c",
  "locator": {
    "id": "DASHBOARD_APP_LOCATOR",
    "state": {
      "dashboardId": "edf84fe0-e1a0-11e7-b6d5-4dc382ef7f5b",
      "timeRange": {
        "from": "now-7d",
        "to": "now"
      }
    },
    "version": "9.4.0"
  },
  "slug": "my-dashboard"
}