Update saved objects in spaces

POST /api/spaces/_update_objects_spaces

Api key auth Basic auth

Update one or more saved objects to add or remove them from some spaces.

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
  
  The identifier of the saved object to update.
- type string Required
  
  The type of the saved object to update.
spacesToAdd array[string] Required

The identifiers of the spaces the saved objects should be added to or removed from.

Not more than 1000 elements.
spacesToRemove array[string] Required

The identifiers of the spaces the saved objects should be added to or removed from.

Not more than 1000 elements.

Responses

200 application/json

OK: A successful request.

POST /api/spaces/_update_objects_spaces

curl \
 --request POST 'https://localhost:5601/api/spaces/_update_objects_spaces' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '"{\n  \"objects\": [\n    {\n      \"type\": \"index-pattern\",\n      \"id\": \"90943e30-9a47-11e8-b64d-95841ca0b247\"\n    }\n  ],\n  \"spacesToAdd\": [\n    \"test\"\n  ],\n  \"spacesToRemove\": []\n}"'

Request example

Update the spaces of each saved object and all its references.

{
  "objects": [
    {
      "type": "index-pattern",
      "id": "90943e30-9a47-11e8-b64d-95841ca0b247"
    }
  ],
  "spacesToAdd": [
    "test"
  ],
  "spacesToRemove": []
}

Response examples (200)

The response from updating the spaces of saved objects.

{
  "objects": [
    {
      "type": "index-pattern",
      "id": "90943e30-9a47-11e8-b64d-95841ca0b247",
      "spaces": [
        "default",
        "test"
      ]
    }
  ]
}