Create a short URL
https://{kibana_url}
- POST /api/short_url
Kibana URLs may be long and cumbersome, short URLs are much easier to remember and share. Short URLs are created by specifying the locator ID and locator parameters. When a short URL is resolved, the locator ID and locator parameters are used to redirect user to the right Kibana page.
Request
-
humanReadableSlugboolean -
When the
slugparameter is omitted, the API will generate a random human-readable slug ifhumanReadableSlugis set to true. -
locatorIdstringrequired -
The identifier for the locator.
-
paramsobjectrequired -
An object which contains all necessary parameters for the given locator to resolve to a Kibana location.
warn When you create a short URL, locator params are not validated, which allows you to pass arbitrary and ill-formed data into the API that can break Kibana. Make sure any data that you send to the API is properly formed.
-
slugstring -
A custom short URL slug. The slug is the part of the short URL that identifies it. You can provide a custom slug which consists of latin alphabet letters, numbers, and
-._characters. The slug must be at least 3 characters long, but no longer than 255 characters.
Response
Indicates a successful call.
-
accessCountinteger -
Number of times the short URL has been resolved.
-
accessDateinteger -
Unix epoch (milliseconds) of the last time the short URL was resolved. Set to the creation time when the URL has never been accessed.
-
createDateinteger -
Unix epoch (milliseconds) when the short URL was created.
-
idstring -
The identifier for the short URL.
-
locatorobject -
slugstring -
A random human-readable slug is automatically generated if the
humanReadableSlugparameter is set totrue. If it is set tofalse, a random short string is generated.