Delete a custom rule set

delete

https://{hostname}/delivery-manager/v1/workspaces/{workspaceName}/environments/{environmentName}/rule-sets/{ruleSetName}

This operation deletes a custom rule set and its versions. By default, you can only delete a rule set after removing any references to it from environment versions. Set ignoreIfInUse to true to return success without deleting when the rule set is still referenced.

Path Params

workspaceName

string

required

Name of the workspace that unifies all resources for your application or service. You can rename the workspace with a separate operation after you initially create the resource.

environmentName

string

required

Name of the environment, unique within a workspace. You can't modify it after you initially create it with a POST request.

ruleSetName

string

required

A unique name for the rule set.

Query Params

ignoreIfInUse

boolean

Defaults to false

This parameter prevents delete errors by ignoring whether a rule set is in use. When true, the delete operation skips any custom rule set still referenced by an environment version and returns success. Defaults to false, which fails the request when the custom rule set is still referenced in an environment version.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

204

Successfully deleted the custom rule set, or ignored it because it's still referenced and ignoreIfInUse is true.