DELETE /v1/apiEndpoints/{id}
Delete an API Endpoint
Soft delete or permanently remove an API endpoint entity by UUID or fully qualified name, controlling cascade behavior and maintaining audit trails via the Collate REST API.
DELETE
DELETE /v1/apiEndpoints/{id}
Delete an API Endpoint
Delete an API endpoint by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.Delete by ID
string
required
UUID of the API endpoint to delete.
boolean
default:"false"
Recursively delete child entities.
boolean
default:"false"
Permanently delete the API endpoint. If
false, the API endpoint is soft-deleted and can be restored.Delete by Name
UseDELETE /v1/apiEndpoints/name/{fqn} to delete by fully qualified name.
string
required
Fully qualified name of the API endpoint (e.g.,
sample_api_service.pet.addPet).boolean
default:"false"
Recursively delete child entities.
boolean
default:"false"
Permanently delete the API endpoint.
Restore a Soft-Deleted API Endpoint
UsePUT /v1/apiEndpoints/restore to restore a soft-deleted API endpoint.
string
required
UUID of the soft-deleted API endpoint to restore.
DELETE /v1/apiEndpoints/{id}
Returns
Soft delete returns the API endpoint object withdeleted: true. Hard delete returns no content (204). Restore returns the restored API endpoint object.