Policy
A Policy (1.47.0): the editable draft of a rule bound to one hook with one action type, with the lint analysis of the draft's document. Calls run published Policy versions, never the draft.
An object with 21 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
action_type | PolicyActionType | yes | The one action type the document may output; its legality at hook is checked at save. |
active_version | integer or null | yes | The version Agent version publish pins (agent scope) or dispatch resolves (organization scope), or null when none is active. |
analysis | PolicyAnalysis | yes | |
archived_at | Timestamp or null | yes | When DELETE archived the Policy, or null. An archived Policy takes no write, publish or activation (409 policy_archived); its pinned versions keep running. |
compliance_tag | ComplianceTag or null | yes | |
created_at | Timestamp | yes | |
description | string or null | yes | For reviewers; never sent to the model. |
enabled | boolean | yes | The kill switch, read at dispatch and effective from the next Call; not part of any version. |
hook | HookPoint | yes | |
id | PolicyId | yes | |
latest_version | integer or null | yes | The highest published version, or null before the first publish. |
logic | JdmDocument | yes | |
name | PolicyName | yes | |
object | "policy" | yes | |
organization_id | OrganizationId | yes | |
origin | PolicyOrigin | yes | |
priority | integer | yes | Lower runs first; ties go to organization scope, then to the id. |
revision | integer | yes | Counts writes to the draft; returned as the ETag and required in If-Match. |
scope | PolicyScope | yes | |
setting_path | SettingPath or null | yes | For a derived Policy, the setting it was compiled from; null when authored. |
updated_at | Timestamp | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.