Share feedback
Answers are generated based on the documentation.
Product manualDownload OpenAPI specificationMarkdown

Schema

CreateRuleRequest

Type: object

Fields required to create a new rule within a policy's rule set.
actions · required

Schema: RuleActions

decision · required

Schema: RuleDecision

name · required

Type: string

Human-readable label for the rule.
All schema constraints and annotations
{
  "description": "Human-readable label for the rule.",
  "examples": [
    "allow research mirrors"
  ],
  "type": "string"
}
resources · required

Schema: RuleResources

All schema constraints and annotations
{
  "description": "Fields required to create a new rule within a policy's rule set.",
  "properties": {
    "actions": {
      "$ref": "#/components/schemas/RuleActions"
    },
    "decision": {
      "$ref": "#/components/schemas/RuleDecision"
    },
    "name": {
      "description": "Human-readable label for the rule.",
      "examples": [
        "allow research mirrors"
      ],
      "type": "string"
    },
    "resources": {
      "$ref": "#/components/schemas/RuleResources"
    }
  },
  "required": [
    "name",
    "actions",
    "resources",
    "decision"
  ],
  "type": "object"
}