New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« URL shortening API Upgrade assistant APIs »
Elastic Docs ›Kibana Guide [7.4] ›REST API ›URL shortening API

Shorten URL API

edit

Shorten URL API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Convert a Kibana URL into a token.

Request

edit

POST /api/shorten_url

Request body

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

Response body

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

Response code

edit
200
Indicates a successful call.

Example

edit
POST api/shorten_url
{
  "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)"
}
Copy as curl 

The API returns the following result:

{
  "urlId": "f73b295ff92718b26bc94edac766d8e3"
}

For easy sharing, construct the shortened Kibana URL:

http://localhost:5601/goto/f73b295ff92718b26bc94edac766d8e3

« URL shortening API Upgrade assistant APIs »

On this page

Was this helpful?
Feedback