Swap saved object references

Base URL: https://{kibana_url}

POST /api/data_views/swap_references

Swap saved object references from one data view to another. Use this endpoint to update dashboards, visualizations, and other saved objects that reference a data view. WARNING: Misuse can break large numbers of saved objects! Use the _preview endpoint to see which saved objects would be affected before making 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

Console Kibana Dev Tools

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

curl Shell

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

Request Console 1 / 2 languages

Swap all saved object references from one data view to another and delete the source data view afterward.

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The list of saved objects whose references were updated, along with the delete status of the source.

{
  "deleteStatus": {
    "deletePerformed": true,
    "remainingRefs": 0
  },
  "result": [
    {
      "id": "123",
      "type": "visualization"
    }
  ]
}

Authentication

Header parameters

Request body { }

Response

Request body