Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
List the activated regions
The single source of truth for region selection: every ACTIVE region binding whose provider
is ENABLED. code is the platform region id (a RegionId, e.g. ist-1); displayName
falls back to code when the operator set none. A deactivated region drops out of this read
(already-provisioned projects in it keep resolving).
Any authenticated principal may read it (no scope, no platform role).
Async & state: Synchronous read; no state change.
Errors: 401 unauthenticated; 500.
Idempotency/Concurrency: Safe.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
The activated regions.
application/json- response
regions*array<>curl -X GET "https://example.com/regions"{ "regions": [ { "code": "string", "displayName": "string", "icon": "string", "osRegionName": "string", "providerId": "string" } ]}