Waiting for engine...
Skip to main content

DeployedApiPolicyInput

inputs

Input parameters for creating a new policy.

input DeployedApiPolicyInput {
path: String!
rules: [ID!]
appliedWhen: DeployedApiPolicyTiming!
}

Fields

DeployedApiPolicyInput.path ● String! non-null scalar miscellaneous

The path for which this set of rules applies. The longest matching path is chosen and only it's rules are applied must start with '/'. The path is relative to the base API path. For instance, if your API has a base path of 'ws/rest/myapi' then specifying '/' for the path will apply the policy to all endpoints. Specifying '/calculate' will only apply the policy to the 'calculate' endpoint.

DeployedApiPolicyInput.rules ● [ID!] list scalar miscellaneous

List of identifiers of the rules to be included in this policy. Rules will be applied in the order specified in this input.

DeployedApiPolicyInput.appliedWhen ● DeployedApiPolicyTiming! non-null enum platform

Specifies whether the policy is applied before or after the standard policies.

Member Of

DeployedApiInput input ●  DeployedApiPolicyBulkAddInput input

On this Page