Delete multiple entities
This route allows you to delete multiple entities (up to 100 entities per request) from a specific blueprint in your software catalog. All entities must belong to the same blueprint.<br/><br/>If any identifier is missing, the entire operation fails with 404 and nothing is deleted. If any entity has required dependents and delete_dependents is false, the entire operation fails with 403 and nothing is deleted.<br/><br/>Pass allow_partial_success=true to skip missing identifiers and entities with required dependents, delete the rest, and return 207 Multi-Status with errors for the skipped identifiers. If nothing could be deleted, the request still fails with 404 (all missing) or 403 (all have required dependents).<br/><br/>Pass delete_dependents=true to delete required dependents together with the requested entities.<br/><br/>To learn more about entities, check out the documentation.
Request
- Base URL: https://api.port.io
- URL: https://api.port.io/v1/blueprints/{blueprint_identifier}/bulk/entities/delete
- Auth: API key in header Authorization
Path parameters
The identifier of the blueprint to operate on.
Query parameters
If true, this call will also delete all entities with a relation to the deleted entity.
If true, missing identifiers and entities with required dependents are skipped and the rest are deleted (207). Default fails the whole batch (404 / 403).
You can provide a run_id to associate the created entities with a specific action run.
The unique identifier of the workflow node run.
Resync run identifier. Only valid when ocean_info_event_type is resync.
How the operation was triggered.
Request body
Response
Entities deleted successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.