IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Bulk update object API Export objects API »

› › ›

Delete object API

edit

Delete object API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview 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.

Request

edit

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 parameters

edit

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.
id: (Required, string) The object ID that you want to remove.

Query parameters

edit

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 code

edit

200: Indicates a successful call.

Example

edit

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

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

« Bulk update object API Export objects API »