Get the configured data-residency registry (superadmin)

GET

/v1/system/residency

curl --request GET \
  --url https://example.com/v1/system/residency \
  --header 'Authorization: Bearer <token>'

• this engine

Returns the residency registry this instance is configured with. An unconfigured instance answers with an empty region list, not a null one.

Authorizations

• bearerAuth

Responses

200

OK

Media type application/json

object

enforces

required

boolean

home_region

required

string

regions

required

Array<string>

Example ^generated

{
  "enforces": true,
  "home_region": "example",
  "regions": [
    "example"
  ]
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}