Delete an entity
DELETE/v1/blueprints/:blueprint_identifier/entities/:entity_identifier
This route allows you to delete a specific entity in your software catalog.
To learn more about entities, check out the documentation.
Request
Path Parameters
entity_identifier stringrequired
Possible values: non-empty
The identifier of the entity you want to delete.
blueprint_identifier stringrequired
Possible values: non-empty
The identifier of the blueprint the entity belongs to.
Query Parameters
delete_dependents booleanrequired
If true, this call will also delete all entities with a relation to the deleted entity.
Default value:
falserun_id string
You can provide a run_id to associate the deleted entity with a specific action run.
Responses
- 200
- 403
- 404
- 422
- 500
Entity deleted successfully
One of the following errors occurred:
| Error | Description |
|---|---|
| missing_permissions | You do not have permissions to perform the requested operation. For further details, please contact your admin |
| has_dependents | The entity has dependent entities that must be deleted along with it. To do that, use "delete_dependents=true" |
One of the following errors occurred:
| Error | Description |
|---|---|
| not_found | An entity with the provided identifier was not found |
| not_found | A blueprint with the provided identifier was not found |
One of the following errors occurred:
| Error | Description |
|---|---|
| invalid_request | The provided data does not match the route schema |
One of the following errors occurred:
| Error | Description |
|---|---|
| internal_error | An internal error occurred |