NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« URL Shortening API Upgrade Assistant API »
Elastic Docs ›Kibana Guide [6.8] ›REST API ›URL Shortening API

Shorten URL

edit

Shorten URL

edit

The Shorten URL API allows for converting a Kibana URL into a token.

Request

edit

POST /api/shorten_url

Request Body

edit

The request body must be a JSON object containing the following properties:

url (required)
(string) Kibana URL, relative to /app/kibana, to be shortened.

Response body

edit

The response body will have a top level urlId property that contains the shortened URL token for the provided request body.

Examples

edit
POST api/shorten_url
{
  "url": "/app/kibana#/dashboard?_g=()&_a=(description:'',filters:!(),fullScreenMode:!f,options:(darkTheme:!f,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)"
}

A successful call returns a response code of 200 and a response body containing a JSON structure similar to the following example:

{
  "urlId": "f73b295ff92718b26bc94edac766d8e3"
}

A shortened Kibana URL can then be constructed for easier sharing. http://localhost:5601/goto/f73b295ff92718b26bc94edac766d8e3

« URL Shortening API Upgrade Assistant API »