POST /api/spaces/_get_shareable_references
Api key auth Basic auth

Collect references and space contexts for saved objects.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json

Body

  • objects array[object] Required

    Not more than 1000 elements.

    Hide objects attributes Show objects attributes object
    • id string Required
    • type string Required

Responses

  • 200 application/json

    Indicates a successful call.

POST /api/spaces/_get_shareable_references 
curl \
 --request POST 'https://localhost:5601/api/spaces/_get_shareable_references' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"objects":[{"type":"dashboard","id":"my-dashboard-id"}]}'
Request example
Collect references and space contexts for a dashboard saved object. 
{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard-id"
    }
  ]
}
Response examples (200)
A response that includes the collected references and the spaces where the objects exist. 
{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard-id",
      "spaces": [
        "default",
        "marketing"
      ],
      "inboundReferences": []
    }
  ]
}