Atlas
Admin — Data Residency

Request region migration

Creates a region migration request for the workspace. Phase 1: the request is recorded with status 'pending' and fulfilled manually. Rate limited to one request per 30 days per workspace.

POST
/api/v1/admin/residency/migrate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3001/api/v1/admin/residency/migrate" \  -H "Content-Type: application/json" \  -d '{    "targetRegion": "string"  }'
{
  "id": "string",
  "workspaceId": "string",
  "sourceRegion": "string",
  "targetRegion": "string",
  "status": "pending",
  "requestedBy": "string",
  "requestedAt": "string",
  "completedAt": "string",
  "errorMessage": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
Edit on GitHub

Last updated on