Skip to main content
PATCH
Update Policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policy_id
string<uuid>
required

Body

application/json

Request body for partial updates to an existing policy.

name
string | null

Human-friendly policy name, unique within an organization

description
string | null

Longer description of the policy.

support_contact
string | null

Primary point of contact associated with the policy.

tags
string[] | null

Tags for categorizing the policy.

status
enum<string> | null

The current lifecycle status of the policy.

Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
application_ids
string[] | null

List of application (agent) identifiers to which this policy applies.

rules
PolicyRule · object[] | null

Full set of rules that govern the policy.

Response

Successful Response

Envelope for detail responses.

policy
PolicyDetail · object
required

Detailed representation of a policy including rules.