Delete object API | Kibana Guide [7.12]

» » »

« Update object API Export objects API »

Delete object APIedit

[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Remove Kibana saved objects.

Once you delete a saved object, it cannot be recovered.

Requestedit

DELETE <kibana host>:<port>/api/saved_objects/<type>/<id>

DELETE <kibana host>:<port>/s/<space_id>/api/saved_objects/<type>/<id>

DELETE /s/<space_id>/api/saved_objects/<type>/<id>

Path parametersedit

space_id: (Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.
type: (Required, string) Valid options include visualization, dashboard, search, index-pattern, config, and timelion-sheet.
id: (Required, string) The object ID that you want to remove.

Query parametersedit

force: (Optional, boolean) When true, forces an object to be deleted if it exists in multiple namespaces.

Use this if you attempted to delete an object and received an HTTP 400 error with the following message: "Unable to delete saved object that exists in multiple namespaces, use the force option to delete it anyway"

Response codeedit

200: Indicates a successful call.

Exampleedit

Delete an index pattern object with the my-pattern ID:

$ curl -X DELETE api/saved_objects/index-pattern/my-pattern