Workspace: residency

Where this workspace’s data is held, and whether the Enterprise residency guarantee is in effect

GET /v1/workspace/residency · operation getResidency

Requires the batondeck:workspace:read permission (action residency:read).

Responses

Status	Meaning
200	Where this workspace’s data is held, and whether the Enterprise residency guarantee is in effect
401	No portal session, and no live API key.
403	The policy refused, or the request was cross-site.
404	No such resource, or none this session may see.

200 response schema

{
  "type": "object",
  "properties": {
    "jurisdiction": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "eu",
            "us"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "entitled": {
      "type": "boolean"
    },
    "in_effect": {
      "type": "boolean"
    },
    "reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "covered": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "not_covered": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "jurisdiction",
    "entitled",
    "in_effect",
    "reason",
    "covered",
    "not_covered"
  ],
  "additionalProperties": false
}

curl -X GET 'https://api.batondeck.com/v1/workspace/residency' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"