DeployedApiPolicyRule

Defines a policy rule for API requests with method restrictions and configuration.

type DeployedApiPolicyRule {
  id: ID!
  name: String!
  description: String
  methods: [HttpMethod!]!
  type: ID!
  configuration: String
  usedBy: [DeployedApi!]
  scope: RuleScope
}

Fields

DeployedApiPolicyRule.id ● ID! non-null scalar miscellaneous

Rule identifier

DeployedApiPolicyRule.name ● String! non-null scalar miscellaneous

User-defined rule name. Not used during execution.

DeployedApiPolicyRule.description ● String scalar miscellaneous

A human readable description of this rule. Not used during execution

DeployedApiPolicyRule.methods ● [HttpMethod!]! non-null enum catalog-service

All the HTTP methods for which this rule applies

DeployedApiPolicyRule.type ● ID! non-null scalar miscellaneous

Policy id as specified in policy plugin.properties file

DeployedApiPolicyRule.configuration ● String scalar miscellaneous

The JSON-encoded configuration for the rule

DeployedApiPolicyRule.usedBy ● [DeployedApi!] list object platform

List of deployed APIs that are using this rule

DeployedApiPolicyRule.scope ● RuleScope enum platform

Scope for the rule, determined by rule type and configuration, if rule can be used for both, request and response.

Returned By

deployedApiPolicyRule query ●  deployedApiPolicyRuleCreate mutation ●  deployedApiPolicyRules query ●  deployedApiPolicyRuleUpdate mutation

Member Of

DeployedApiPolicy object