Sign in

v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-01140308542.4 KB
Zones

Update zone

Updates a zone's configuration (partial update)

patch/zones/{zoneId}

Path parameters

zoneIdstring required

Zone ID

Request body

namestring safe-text

Human-readable name. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

descriptionstring safe-text nullable

Human-readable description. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

requires_invitationboolean

Whether the zone requires an invitation for email/password registration, only applies when user_identity_provider_id is not set

user_identity_provider_idstring nullable

Provider ID to configure for user login (set to null to unset)

default_mcp_gateway_application_idstring nullable

Application ID configured as the default MCP Gateway for the zone (set to null to unset)

default_resource_idstring nullable

Resource ID to configure as the default resource for the zone (set to null to unset)

Response

A zone for organizing resources within an organization

idstring required

Unique identifier of the zone

organization_idstring required

Organization that owns this zone

slugstring required

URL-safe identifier, unique within the zone

namestring required

Human-readable name

descriptionstring nullable

Human-readable description

user_identity_provider_idstring

Provider ID configured for user login

requires_invitationboolean

Whether the zone requires an invitation for email/password registration, only applies when user_identity_provider_id is not set

default_mcp_gateway_application_idstring

Application ID configured as the default MCP Gateway for the zone

default_resource_idstring

Resource ID configured as the default resource for the zone

permissionsIamPermissions

Permissions granted to the authenticated principal. Only populated when expand[]=permissions query parameter is provided. Keys are resource types, values are objects mapping action names to boolean values.

owner_type'platform' | 'customer' required

Who owns this zone. Platform-owned zones cannot be modified via API.

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Example response

{
  "permissions": {
    "zones": {
      "read": true,
      "update": true,
      "delete": false,
      "create": false
    },
    "applications": {
      "read": true,
      "list": true,
      "create": false
    }
  }
}