Skip to main content
GET
Get a region
Requires no IAM action. Access is decided by the endpoint’s own rules rather than by a policy — see the description above.

Path Parameters

code
string
required

Immutable region code.

Pattern: ^[a-z][a-z0-9-]{0,31}$
Example:

"sa-saopaulo-1"

Response

Published region

state
enum<string>
required

Catalog lifecycle, independent of health and capacity. Retired codes are never reused.

Available options:
planned,
active,
restricted,
retiring,
retired
Example:

"active"

accepting_new_resources
boolean
required

True only for active regions. Product services still enforce eligibility, quotas, placement and capacity.

Example:

true

crn
string
required

Platform-owned global region identity, using the immutable region code.

Example:

"crn:catalog::platform:region/sa-saopaulo-1"

code
string
required

Unique region code used in API calls and CRNs

Example:

"sa-saopaulo-1"

name
string
required

Human-readable region name

Example:

"São Paulo 1"

location
string
required

Geographic location of the region

Example:

"São Paulo, Brazil"

country_code
string
required

ISO 3166-1 alpha-2 country code (used to display flag in UI)

Required string length: 2
Example:

"BR"

available
boolean
required

Compatibility alias for accepting_new_resources; not a live health signal

Example:

true

coming_soon
boolean
required

Compatibility flag that is true only when state is planned

Example:

false