Skip to main content
Feedback

Configuration reference

Use this reference when filling out the Create Policy Template or Edit form, or when working with policy templates via the GraphQL API. The table maps each UI label to its underlying field name, describes what it controls, and lists any constraints or valid values.

For step-by-step instructions on using these fields, refer to Manage policy templates.

The following table describes the fields available when creating or managing a policy template.

FieldUI LabelDescriptionRequiredConstraints
nameTemplate NameDisplay name for the templateYesMust be unique per account.
descriptionDescriptionFree-text description of the template's purposeNo
rulesPolicy RulesOne or more policy rules selected from existing rules in the accountYesAt least one rule required. Rules must already exist in the account.
appliedWhenExecution TimingControls when the rule runs relative to standard policiesYes per ruleUI options: Before Request And Before Standard Policies, Before Request And After Standard Policies, After Response and Before Standard Policies, After Response and After Standard Policies. Changing this overrides the rule's individual timing setting.
versionVersionAuto-incremented number tracking the template revisionAuto-assignedStarts at 1.0. Increments on each edit when the template is assigned to one or more APIs.
templateCorrelationIdStable identifier shared across all versions of a templateAuto-assignedRead-only. Links all version records back to the same original template. Used in GraphQL queries.
pathThe API deployment path at which the template is appliedYes at assignmentMust be a valid URL path. Example: /api/v1/*.

The Policy Rules table on the Create and Edit forms also displays the following read-only columns for each available rule:

ColumnDescription
Policy NameThe name of the policy rule.
Execution TimingDropdown — set per rule when adding to the template.
MethodsHTTP methods the rule applies to (for example, GET, POST).
TypeThe rule implementation type (for example, groovy).
ConfigurationThe rule's JSON configuration object.