Delete an entity in Entity Store

DELETE /api/entity_store/entities/{entityType}
Api key auth Basic auth

Spaces method and path for this operation:

delete /s/{space_id}/api/entity_store/entities/{entityType}

Refer to Spaces for more information.

Delete a single entity in Entity Store. The entity will be immediately deleted from the latest index. It will remain available in historical snapshots if it has been snapshotted. The delete operation does not prevent the entity from being recreated if it is observed again in the future.

Path parameters

  • entityType string Required

    Values are user, host, service, or generic.

application/json

Body Required

Schema for the deleting entity

  • id string Required

    Identifier of the entity to be deleted, commonly entity.id value.

Responses

  • 200 application/json

    Successful response. Entity deleted.

    Hide response attribute Show response attribute object
    • deleted boolean
  • 404

    Entity Not Found. No entity with this ID and Type exists.

  • 503

    Operation on an uninitialized Engine or in a cluster without CRUD API Enabled

DELETE /api/entity_store/entities/{entityType} 
curl \ --request DELETE 'https://localhost:5601/api/entity_store/entities/{entityType}' \ --header "Authorization: $API_KEY" \ --header "Content-Type: application/json" \ --data '{"id":"string"}'