Preview swap references

Base URL: https://{kibana_url}

POST /api/data_views/swap_references/_preview
POST /s/{space_id}/api/data_views/swap_references/_preview

Refer to Spaces for more information.

Preview the effect of swapping saved object references from one data view to another. Returns the list of affected saved objects without making any changes.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Response

Indicates a successful call.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Preview the saved objects that would be affected by swapping references from one data view to another.

Console Kibana Dev Tools

POST kbn://api/data_views/swap_references/_preview
{"fromId":"abcd-efg","toId":"xyz-123"}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/data_views/swap_references/_preview" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{"fromId":"abcd-efg","toId":"xyz-123"}'

Response

The result array lists every saved object that references the source data view. No saved objects are modified by the preview endpoint.

{
  "result": [
    {
      "id": "8963ca30-bca7-11e8-aa00-0123456789ab",
      "type": "visualization"
    },
    {
      "id": "edf84fe0-e1a0-11e7-b6d5-4dc382ef7f5b",
      "type": "dashboard"
    }
  ]
}

Authentication

Header parameters

Request body { }

Response

Request body