Claude Platform Docs

Update Workspace

$ ant beta:organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}

Update Workspace

Parameters
--workspace-id: string⁠Path parameter
--data-residency: optional BetaDataResidencyUpdateConfig { allowed_inference_geos, default_inference_geo }

Data residency configuration for the workspace.

allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted"

Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
"global"
"us"
unrestricted: "unrestricted"
default_inference_geo: optional "global" or "us"

Default inference geo applied when requests omit the parameter. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
"global"
"us"
--display-color: optional string

Hex color code representing the Workspace in the Anthropic Console.

maxLength7
pattern^#[0-9A-Fa-f]{6}$
--external-key-id: optional string

ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value for an AWS KMS key is the key's ARN, and your organization's own key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the external_key_id stays the same.

--name: optional string

Name of the Workspace.

minLength1
maxLength255
--tags: optional map[string]

User-defined tags as string key-value pairs. Keys may not begin with anthropic.

--user-profile-id: optional string

ID of a user profile to attach to the Workspace. Every inference request through the Workspace must then name this user profile; the API rejects a request that names none or a different one. Once set, it can't be replaced or removed (sending the same ID again changes nothing); only deleting the user profile clears it. It can't be set on a Workspace whose External Key isn't bound to this user profile. The default Workspace can't have a user profile.

Returns
beta_workspace: object{ type: "workspace", id, archived_at, 8 more }
Errors

Any method can also return the general HTTP errors.

Each code below is the value of error.details.error_code in the response body.

error code external_key_validation_failedHTTP status 400

The External Key failed Anthropic's validation, so the request was refused. The message gives the reason, if there is one.

error code external_key_validation_timed_outHTTP status 400

Anthropic's validation of the External Key did not finish in time, so the request was refused. Wait a moment, then send the request again.

error code key_profile_mismatchHTTP status 400

After this request, the External Key and the Workspace would not have the same user profile. A key and its Workspace must have the same user profile, or both have none.

error code user_profile_not_foundHTTP status 400

The request depends on a user profile that does not exist in the organization or is no longer active. The request either names this user profile by ID, or names a resource, such as an External Key, that is bound to it.

error code workspace_policy_violationHTTP status 400

The request breaks the organization's Workspace Policy. The message says which rule it broke; an organization admin can see and change the policy in the Console.

error code sandbox_egress_restrictedHTTP status 403

The request came from a Claude sandbox with restricted network access, which is not allowed to make this change. Send it from outside the sandbox, or from a sandbox with unrestricted network access.

error code external_key_changedHTTP status 409

The external key changed while the request was validating it. Send the request again.

Update Workspace
ant beta:organization:workspaces update \
  --workspace-id workspace_id
Returns Examples
Response 200
{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "data_residency": {
    "allowed_inference_geos": "unrestricted",
    "default_inference_geo": "global",
    "workspace_geo": "us"
  },
  "display_color": "#6C5BB9",
  "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  },
  "type": "workspace",
  "user_profile_id": "uprof_01SDCCSbTxrXDpWc1phhtcfK"
}