catalog.relationEdges.remove

Remove an existing relation edge between two entities in your software catalog.

Facts


HTTP Method	`POST https://api.getdx.com/catalog.relationEdges.remove`
Scope	`catalog:write:entities`

Arguments

Required arguments

Parameter	Type	Description
`relation_identifier`	`string`	The identifier of the relation type.
`source_entity_identifier`	`string`	The identifier of the source entity.
`target_entity_identifier`	`string`	The identifier of the target entity.

All identifiers must exist for the account — the request fails if any are not found.

Each entity identifier must be of the correct entity type for its role in the relation, matching catalog.relationEdges.add. For example, if a relation is defined between service (source) and api (target), passing an identifier for a different entity type returns an invalid_entity_type error.

There must already be an edge for that relation and entity pair. If no such edge exists, the request fails with edge_not_found.

Example request

This is a typical request:

curl -X POST https://api.getdx.com/catalog.relationEdges.remove \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx' \
  --data '{
    "relation_identifier": "service-depends-on-service",
    "source_entity_identifier": "login-frontend",
    "target_entity_identifier": "legacy-product-backend"
  }'

Example response

This is a typical success response:

{
  "ok": true
}

Errors

Error	Description
`not_authed`	No authentication token provided.
`invalid_auth`	Some aspect of authentication cannot be validated.
`invalid_arguments`	Missing required parameters or malformed request body. Error details will indicate the specific issue.
`relation_not_found`	The relation identifier does not exist for the account.
`entity_not_found`	The source or target entity identifier does not exist for the account.
`edge_not_found`	No edge exists for the given relation and source/target pair.
`invalid_entity_type`	The source or target entity identifier is of the wrong entity type for the relation (e.g. passing a `widget` identifier where a `service` is expected).

This table lists only the common expected errors for this method. You should also expect standard service availability errors.