Get shareable references

Base URL: https://{kibana_url}

POST /api/spaces/_get_shareable_references

Auth

Collect references and space contexts for saved objects.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

objects object[] · max items: 1000 required

Response

200

Indicates a successful call.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Collect references and space contexts for a dashboard saved object.

Console Kibana Dev Tools

POST kbn:/api/spaces/_get_shareable_references
{
  "objects": [
    {
      "type": "dashboard",
      "id": "my-dashboard-id"
    }
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/spaces/_get_shareable_references" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "objects": [
      {
        "type": "dashboard",
        "id": "my-dashboard-id"
      }
    ]
  }'

Generated from the API spec

Response

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": []
    }
  ]
}

Header parameters

Request body { }

Response

Request body