Patch Workspace

Update a workspace.

PATCH /api/v1/workspaces/{workspace_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "is_personal": true,
  "is_deleted": true,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_handle": "<string>",
  "data_plane_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

workspace_id · string<uuid> · required

Body

application/json

Patch model for the workspace.

display_name · string · required

Minimum string length: 1

Pattern: ^[a-zA-Z0-9\-_ '@()]+$

Response

200

application/json

Successful Response

Tenant schema.

id · string<uuid> · required

created_at · string<date-time> · required

display_name · string · required

is_personal · boolean · required

is_deleted · boolean · required

organization_id · string<uuid> | null

tenant_handle · string | null

data_plane_url · string | null