Atlas
Admin — Data Residency

Get workspace data residency status

Returns the data residency configuration for the current workspace, including the assigned region (if any) and available regions.

GET
/api/v1/admin/residency

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3001/api/v1/admin/residency"
{
  "configured": true,
  "region": "string",
  "regionLabel": "string",
  "assignedAt": "string",
  "defaultRegion": "string",
  "availableRegions": [
    {
      "id": "string",
      "label": "string",
      "isDefault": true
    }
  ]
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
Edit on GitHub

Last updated on