Skip to content

Create a region-config

POST
/region-configs
object
data
object
region
required

Provider region identifier (e.g. us-east-1, eu-west-1, ap-southeast-1)

string
provider
required
string
Allowed values: aws gcp azure hetzner
display_name

Human-readable region label (e.g. US East (N. Virginia))

string
is_primary

Designates this as the primary region for the provider within the organisation. Only one region per provider per organisation may be primary.

boolean
is_enabled
boolean
replication_target

DocumentId of the target region-config that receives replicated data from this region

string
latency_ms

Last measured round-trip latency from primary in milliseconds

integer
status
string
Allowed values: active degraded maintenance offline
organisation
One of:

DocumentId reference to api::organisation.organisation

string

Created

object
data
object
region
required

Provider region identifier (e.g. us-east-1, eu-west-1, ap-southeast-1)

string
provider
required
string
Allowed values: aws gcp azure hetzner
display_name

Human-readable region label (e.g. US East (N. Virginia))

string
is_primary

Designates this as the primary region for the provider within the organisation. Only one region per provider per organisation may be primary.

boolean
is_enabled
boolean
replication_target

DocumentId of the target region-config that receives replicated data from this region

string
latency_ms

Last measured round-trip latency from primary in milliseconds

integer
status
string
Allowed values: active degraded maintenance offline
organisation
One of:

DocumentId reference to api::organisation.organisation

string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Validation error

Missing or invalid authentication

Not authorized (tenant scope or capability)