Replace customer controls

Replaces the customer’s override with exactly the fields you send. A production key may only TIGHTEN the organization’s controls through this endpoint (narrow an allowlist, add to a denylist, turn ZDR on); anything that loosens them is rejected with 403 scoped_controls_loosening_forbidden. Loosening is available in the dashboard, which requires the organization-settings permission. A customer-scoped API key cannot change its own controls (403). Synced to the data plane before the response returns; a failed sync is a 502 and nothing is stored.

Replaces the customer's override with exactly the fields you send. A production key may only TIGHTEN the organization's controls through this endpoint (narrow an allowlist, add to a denylist, turn ZDR on); anything that loosens them is rejected with 403 `scoped_controls_loosening_forbidden`. Loosening is available in the dashboard, which requires the organization-settings permission. A customer-scoped API key cannot change its own controls (403). Synced to the data plane before the response returns; a failed sync is a 502 and nothing is stored.

Authentication

AuthorizationBearer

Your production key sent as a bearer token.

Path parameters

customer_idstringRequired

Request

This endpoint expects an object.

zero_data_retentionboolean or nullOptional

Tri-state: omit to inherit the organization’s setting, send false to turn organization-wide ZDR OFF for this scope, true to turn it on.

ignored_vendorslist of stringsOptional

Vendors this scope may never route to

allowed_vendorslist of stringsOptional

When non-empty, the only vendors this scope may route to

vendor_routing_preferencelist of stringsOptional

Soft ordering hint among the vendors that remain; never excludes a vendor

ignored_regionslist of stringsOptional

Region tokens (ISO country code or coarse region such as EU, NA) this scope may never route to

allowed_regionslist of stringsOptional

When non-empty, the only region tokens this scope may route to. Vendors with no known region are excluded.

Response

The stored override and the resulting effective controls.

scopestringOptional

scope_idstringOptionalformat: "uuid"

overrideobjectOptional

Exactly what this scope stores, unit-wrapped: zero_data_retention, vendors {ignored_vendors, allowed_vendors, vendor_routing_preference}, regions {ignored_regions, allowed_regions}. Empty means it inherits everything.

effectiveobjectOptional

The controls actually in force for the scope: the organization’s with this scope’s units applied. For a customer, a project is not folded in; at request time a customer override still wins over a project’s.

sourcesmap from strings to stringsOptional

Per unit (zero_data_retention, vendors, regions), which scope supplied the effective value: org or this scope

Errors

403

Forbidden Error

422

Unprocessable Entity Error