IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Shorten URL
editShorten URLedit
The Shorten URL API allows for converting a Kibana URL into a token.
Requestedit
POST /api/shorten_url
Request Bodyedit
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 bodyedit
The response body will have a top level urlId
property that contains
the shortened URL token for the provided request body.
Examplesedit
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