Skip to main content
PATCH
Update policy

Path Parameters

workspaceSlug
string
required

URL-safe workspace identifier.

policySlug
string
required

URL slug of the policy, unique within its workspace.

Body

application/json

Request payload for updating an existing workspace policy.

Replacing the definition replaces the whole policy body.

Request payload for updating an existing workspace policy.

Replacing the definition replaces the whole policy body.

definition
object

New policy body (replaces the stored definition).

description
string

Policy description.

Maximum string length: 4096
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.

displayName
string
required

Human-readable policy display name.

slug
string
required

URL slug of the policy, unique within its workspace.

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

When the policy was last updated.

workspaceSlug
string
required

Handle of the workspace this policy belongs to.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description
string

Policy description.