Skip to main content
PATCH
Update policy

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

policyId
string<uuid>
required

Id of the policy.

Body

application/json

Request payload for updating an existing workspace policy.

Replacing the definition replaces the whole policy body. The policy's template origin is server-owned and preserved across updates — it is not settable here.

Request payload for updating an existing workspace policy.

Replacing the definition replaces the whole policy body. The policy's template origin is server-owned and preserved across updates — it is not settable here.

definition
object

New policy body (replaces the stored definition).

description
string

Policy description.

displayName
string

Human-readable policy display name.

Required string length: 1 - 255

Response

Response type for a workspace policy.

Response type for a workspace policy.

createdAt
string<date-time>
required

When the policy was created.

createdBy
object
required

Account that created this policy.

definition
object
required

The structured policy body consumed by the engine (the current version).

displayName
string
required

Human-readable policy display name.

id
string<uuid>
required

Unique identifier of the policy.

kind
required

How the policy came to exist. A one-shot policy (minted from labels) is content-addressed, deduplicated, and immutable; an authored policy is a normal, editable policy.

Allowed value: "authored"
updatedAt
string<date-time>
required

When the policy was last updated.

versionNumber
integer<int32>
required

The current version number of the policy's definition.

workspaceHandle
string
required

URL-safe workspace handle. Display-only.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
workspaceId
string<uuid>
required

Unique identifier of the workspace.

description
string

Policy description.