latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
ResourceDefinition

Delete a Resource Definition.

If there are no Active Resources provisioned via the current definition, the Resource Definition is deleted immediately.

If there are Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced.

The request can take an optional force query parameter. If set to true, the current Resource Definition is deleted immediately even if there are Active Resources linked to it.
The Resource Definition that has been marked for deletion cannot be used to provision new resources.

With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available).

delete/orgs/{orgId}/resources/defs/{defId}

Path parameters

orgIdstring required

The Organization ID.

defIdstring required

The Resource Definition ID.

Query parameters

forceboolean

If set to true, will mark the Resource Definition for deletion, even if it affects existing Active Resources.

Response

Resource Definition has been marked as deleted.