Entities

Delete an entity

This route allows you to delete a specific entity in your software catalog.<br/><br/>To learn more about entities, check out the documentation.

delete/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}
  • Auth: API key in header Authorization

Path parameters

entity_identifierstring required

The identifier of the entity to operate on.

blueprint_identifierstring required

The identifier of the blueprint to operate on.

Query parameters

delete_dependentsboolean required

If true, this call will also delete all entities with a relation to the deleted entity.

allow_partial_successboolean

If true, missing identifiers and entities with required dependents are skipped and the rest are deleted (207). Default fails the whole batch (404 / 403).

run_idstring

You can provide a run_id to associate the created entities with a specific action run.

node_run_identifierstring

The unique identifier of the workflow node run.

ocean_info_resync_idstring

Resync run identifier. Only valid when ocean_info_event_type is resync.

ocean_info_event_typestring

How the operation was triggered.

Response

Entities deleted successfully

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.