Delete saved objects

Base URL: https://{kibana_url}

POST /api/saved_objects/_bulk_delete

Auth Deprecated

Warning

This API is deprecated. This is a legacy Saved Objects API and may be removed in a future version of Kibana.

Deletes multiple Kibana saved objects in a single request.

There is currently no complete replacement for deleting arbitrary saved objects via an HTTP API.

Query parameters

force boolean: When true, force deletion of multi-namespace objects from all namespaces.

Header parameters

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

Request body

<array> object[] · max items: 10000

Responses

200

A bulk delete response.

application/json

400

A bad request.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/saved_objects/_bulk_delete?force=false
[{"type":"dashboard","id":"example-dashboard-1"},{"type":"dashboard","id":"does-not-exist"}]

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/saved_objects/_bulk_delete?force=false" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '[{"type":"dashboard","id":"example-dashboard-1"},{"type":"dashboard","id":"does-not-exist"}]'

Response

No example

{
  "error": "Bad Request",
  "message": "Unsupported saved object type(s): unknownType",
  "statusCode": 400
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/saved_objects/_bulk_delete
[
  {
    "id": "example-dashboard-1",
    "type": "dashboard"
  },
  {
    "id": "does-not-exist",
    "type": "dashboard"
  }
]

Generated from the API spec

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/saved_objects/_bulk_delete" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "id": "example-dashboard-1",
      "type": "dashboard"
    },
    {
      "id": "does-not-exist",
      "type": "dashboard"
    }
  ]'

Generated from the API spec

Response

{
  "statuses": [
    {
      "id": "example-dashboard-1",
      "success": true,
      "type": "dashboard"
    },
    {
      "error": {
        "error": "Not Found",
        "message": "Saved object [dashboard/does-not-exist] not found",
        "statusCode": 404
      },
      "id": "does-not-exist",
      "success": false,
      "type": "dashboard"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "Unsupported saved object type(s): unknownType",
  "statusCode": 400
}

Query parameters

Header parameters

Request body [{ }]

Responses

Request body