Sign in
PolicyBindings

Create or replace a policy set binding

Upserts a binding for a slot identified by (scope_type, scope_target_id, mode). If a binding already exists for the slot, it is replaced. The binding ID is stable per slot and survives replacements.

put/zones/{zone_id}/policy-bindings

Path parameters

zone_idstring required

The zone identifier

Headers

X-API-Versionstring

API version header (date-based, e.g. 2026-02-01)

X-Client-Request-IDstring uuid

Unique request identifier specified by the originating caller and passed along by proxies.

Request body

scope_type'zone'

Deprecated. Use target_type instead.

scope_target_idstring

Deprecated. Use target_id instead.

target_type'zone'

What the binding targets. Only zone is supported for direct binding writes.

target_idstring

Defaults to zone_id for zone targets. Required for other targets.

mode'shadow' required

Binding mode

policy_set_idstring required

Public ID of the policy set to bind

policy_set_version_idstring required

Public ID of the policy set version to bind

Response

The binding was created or replaced

idstring required

Binding identifier (stable per slot)

scope_type'zone' required

Deprecated. Use target_type instead. Carries the same value.

scope_target_idstring required

Deprecated. Use target_id instead. Carries the same value.

target_type'zone' | 'user' required

What this binding targets

target_idstring required

Target entity ID. Equals zone_id for zone-targeted bindings.

mode'active' | 'shadow' required

Binding mode

policy_set_idstring required

Public ID of the bound policy set

policy_set_version_idstring required

Public ID of the bound policy set version

created_atstring date-time required

Changes

Changed in 2 of the 23 revisions of this API.110

  • 1a0dd4d857ee19See the full diff
    • ●

      added the new active enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      request property deprecated

      request-property-deprecated

    • ○

      request property deprecated

      request-property-deprecated

    • ○

      response property scope_target_id deprecated

      response-property-deprecated

    • ○

      response property scope_type deprecated

      response-property-deprecated

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 932699a5ea161See the full diff
    • ○

      endpoint added

      endpoint-added