Swap saved object references

View as Markdown
POST /api/data_views/swap_references
Api key auth Basic auth

Spaces method and path for this operation:

post /s/{space_id}/api/data_views/swap_references

Refer to Spaces for more information.

Changes saved object references from one data view identifier to another. WARNING: Misuse can break large numbers of saved objects! Practicing with a backup is recommended.

Headers

  • kbn-xsrf string Required

    Cross-site request forgery protection

application/json

Body Required

  • delete boolean

    Deletes referenced saved object if all references are removed.

  • forId string | array[string]

    Limit the affected saved objects to one or more by identifier.

    One of:
    string-1 string array-2 array[string]
  • forType string

    Limit the affected saved objects by type.

  • fromId string Required

    The saved object reference to change.

  • fromType string

    Specify the type of the saved object reference to alter. The default value is index-pattern for data views.

  • toId string Required

    New saved object reference value to replace the old value.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • deleteStatus object
      Hide deleteStatus attributes Show deleteStatus attributes object
      • deletePerformed boolean
      • remainingRefs integer
    • result array[object]
      Hide result attributes Show result attributes object
      • id string

        A saved object identifier.

      • type string

        The saved object type.
POST /api/data_views/swap_references 
curl \ --request POST 'https://localhost:5601/api/data_views/swap_references' \ --header "Authorization: $API_KEY" \ --header "Content-Type: application/json" \ --header "kbn-xsrf: string" \ --data '{"toId":"xyz-123","delete":true,"fromId":"abcd-efg"}'
Request example 
{ "toId": "xyz-123", "delete": true, "fromId": "abcd-efg" }