The data residency object

⚠️

Preview — this feature is being built; the design below is the spec.

The data_residency object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "type": "data_residency",
  "default_region": "eu",
  "allowed_regions": [
    "eu"
  ],
  "workspace_overrides": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "region": "eu",
      "locked": true
    }
  ],
  "updated_at": "2026-11-05T10:00:00Z",
  "objects_outside_default": {
    "files": 112,
    "memory_stores": 2
  }
}

Fields

Field	Type	Description
`type`	string	The object type, always `data_residency`.
`default_region`	string	`us`, `eu` or `global`. Where requests without a `region` are processed and where files, batches and agent data are stored.
`allowed_regions`	array	Regions a request may ask for with the per-request `region` field. A request for any other region is refused.
`workspace_overrides`	array	Per-workspace region; `locked` stops requests in that workspace from choosing another region.
`updated_at`	string	When it last changed.
`objects_outside_default`	object	Existing stored objects in another region.

Returned by

compliance_user deployment

Was this page helpful?