GET /api/short_url/{id}
Api key auth Basic auth

Get a single Kibana short URL.

Path parameters

  • id string Required

    The identifier for the short URL.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • accessCount integer

      Number of times the short URL has been resolved.

    • accessDate integer(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(int64)

      Unix epoch (milliseconds) when the short URL was created.

    • id string

      The identifier for the short URL.

    • locator object
      Hide locator attributes Show locator attributes object
      • id string

        The identifier for the locator.

      • state object

        The locator parameters.

      • version string

        The version of Kibana when the short URL was created.

    • 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.
GET /api/short_url/{id} 
curl \
 --request GET 'https://localhost:5601/api/short_url/{id}' \
 --header "Authorization: $API_KEY"
Response examples (200)
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"
}