Update Workspace

Update a workspace.

PATCH /workspaces/{workspace_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_agent_preset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settings": {
    "effective_allowed_attachment_extensions": [
      "<string>"
    ],
    "effective_allowed_attachment_mime_types": [
      "<string>"
    ],
    "git_provider": "github",
    "git_repo_url": "<string>",
    "workflow_unlimited_timeout_enabled": true,
    "workflow_default_timeout_seconds": 123,
    "allowed_attachment_extensions": [
      "<string>"
    ],
    "allowed_attachment_mime_types": [
      "<string>"
    ],
    "validate_attachment_magic_number": true
  },
  "unsafe_disable_secret_error_withholding_allowed": false
}

Authorizations

APIKeyCookieServiceAccountApiKeyBearer

fastapiusersauth · string · cookie · required

Path Parameters

workspace_id · string<uuid> · required

Body

application/json

name · string | null

Required string length: 1 - 100

settings · WorkspaceSettingsUpdate · object | null

Show child attributes

default_agent_preset_id · string<uuid> | null

Default agent preset for this workspace. Set to null to clear.

Response

200

application/json

Successful Response

id · string<uuid> · required

name · string · required

organization_id · string<uuid> · required

default_agent_preset_id · string<uuid> | null

settings · WorkspaceSettingsRead · object | null

Show child attributes

unsafe_disable_secret_error_withholding_allowed · boolean · default: false

Whether the organization lets this workspace's actions opt into showing original error details when secrets are in scope.