Sign in
PolicyBindings

Get a policy set binding by ID

Returns a specific binding by its stable identifier.

get/zones/{zone_id}/policy-bindings/{binding_id}

Path parameters

zone_idstring required

The zone identifier

binding_idstring required

The binding 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.

Response

The binding

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.15

  • 1a0dd4d857ee14See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      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