deployedApiPolicyRuleDelete

Deletes DeployedApiPolicyRule. DeployedApiPolicyRule can only be delted if it is not used by any active deployment. If the rule is in use, this mutation returns POLICY_RULE_IN_USE error code. The ids of the deployments using the rule are returned in extensions "parameters" field. Accepts DeployedApiPolicyRule id as input.

Example request to delete DeployedApiPolicyRule:

    mutation {
        deployedApiPolicyRuleDelete(id:"e7301eb5-6301-4500-ad25-6adb1b9cc885")
    }

Example of error request when rule is in use:

    {
        "errors": [
            {
                "message": "This API policy rule cannot be deleted as it is being used by one or more API deployments.",
                "path": [
                    "deployedApiPolicyRuleDelete"
                ],
                "extensions": {
                    "errorCode": "POLICY_RULE_IN_USE",
                    "parameters": [
                        "b776fb1e-a25d-056f-3414-f4162273d058"
                    ],
                    "language": "en-US",
                    "classification": "DataFetchingException"
                }
            }
        ],
        "data": null
    }

deployedApiPolicyRuleDelete(
  id: ID!
): ID!

Arguments

deployedApiPolicyRuleDelete.id ● ID! non-null scalar miscellaneous

Type

ID scalar miscellaneous

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.