---
title: "Create a short URL"
method: POST
path: "/api/short_url"
tags: ["short url"]
---

# Create a short 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 body

- object
  - `humanReadableSlug` boolean — When the `slug` parameter is omitted, the API will generate a random human-readable slug if `humanReadableSlug` is set to true.
  - `locatorId` string, required — The identifier for the locator.
  - `params` object, required — 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.
  - `slug` string — 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 `200`

Indicates a successful call.

- ShortURLAPIsUrlResponse
  - `accessCount` integer — Number of times the short URL has been resolved.
  - `accessDate` integer — 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 — Unix epoch (milliseconds) when the short URL was created.
  - `id` string — The identifier for the short URL.
  - `locator` 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.

---

[API](https://skmtc.net/elastic/apis/kibana-apis.md) · [All operations](https://skmtc.net/elastic/apis/kibana-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/kibana-apis/versions/531c9e2a7d23/schema)