Update a workspace

PUT/v1/workspaces/{slug}

Update a workspace.

Changes the workspace's name, description and default routing config. name is changed only when sent; description and default_routing_config_slug are replaced on every update, so leaving one out clears it. The slug cannot be changed.

Requires workspace admin access: an organization owner or admin, an admin of the workspace, an organization-scoped va_ key with the admin role, or a va_ key scoped to this workspace with the admin role. Errors: 403 without it; 404 when the workspace does not exist.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

slugstringrequired
the workspace's slug

Query parameters

organizationstringrequired
the slug of the organization the workspace belongs to

Request body application/json

the new values

namestring
A new display name; omit to keep the current one.
descriptionstring
The description; omit or send null to clear it.
default_routing_config_slugstring
The routing config the dashboard should select by default for this workspace; omit or send null to clear it.

Responses

200application/json

idstring<uuid>
The workspace's id (UUID), used as workspace_id elsewhere in the API.
organizationstring
The slug of the organization the workspace belongs to.
slugstring
The workspace's slug, unique within the organization, used in workspace URLs.
namestring
The workspace's display name.
descriptionstring
A description of the workspace; absent when none was given.
default_routing_config_slugstring
The routing config the dashboard selects by default for this workspace; absent when none is set.
created_atstring<date-time>
When the workspace was created (ISO 8601 date-time).
updated_atstring<date-time>
When the workspace was last changed (ISO 8601 date-time).

Request

curl -X PUT "https://api.vectoraxis.ai/v1/workspaces/{slug}?organization=string" \
  -H "Authorization: Bearer $VECTORAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "default_routing_config_slug": "string"
}'

VectorAxis is built by GK Labs, a member of NVIDIA Inception.