Shorten URL API

[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Convert a Kibana URL into a token. Kibana URLs contain the state of the application, which makes them long and cumbersome. Internet Explorer has URL length restrictions, and some wiki and markup parsers don’t do well with the full-length version of the Kibana URL.

Short URLs are designed to make sharing Kibana URLs easier.

Request

POST <kibana host>:<port>/api/shorten_url

Request body

url

(Required, string) The Kibana URL that you want to shorten, relative to /app/kibana.

Response body

urlId

A top-level property that contains the shortened URL token for the provided request body.

Response code

200

Indicates a successful call.

Example

  1. $ curl -X POST api/shorten_url
  2. {
  3.   "url": "/app/kibana#/dashboard?_g=()&_a=(description:'',filters:!(),fullScreenMode:!f,options:(hidePanelTitles:!f,useMargins:!t),panels:!((embeddableConfig:(),gridData:(h:15,i:'1',w:24,x:0,y:0),id:'8f4d0c00-4c86-11e8-b3d7-01146121b73d',panelIndex:'1',type:visualization,version:'7.0.0-alpha1')),query:(language:lucene,query:''),timeRestore:!f,title:'New%20Dashboard',viewMode:edit)"
  4. }

The API returns the following:

  1. {
  2.   "urlId": "f73b295ff92718b26bc94edac766d8e3"
  3. }

For easy sharing, construct the shortened Kibana URL:

http://localhost:5601/goto/f73b295ff92718b26bc94edac766d8e3

Most Popular