workspaces

Update workspace

Updates a workspace's settings such as display name and labels. The workspace name cannot be changed after creation.

put/workspaces/{workspaceName}

Request

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopesworkspaces:update
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/workspaces/:workspaceName/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workspaceNamestring required

name of the workspace

Request body

createdAtstring

The date and time when the resource was created

updatedAtstring

The date and time when the resource was updated

createdBystring

The user or service account who created the resource

updatedBystring

The user or service account who updated the resource

accountIdstring

Workspace account id

displayNamestring

Workspace display name

idstring

Autogenerated unique workspace id

labelsMetadataLabels

Key-value pairs for organizing and filtering resources. Labels can be used to categorize resources by environment, project, team, or any custom taxonomy.

namestring

Workspace name

regionstring

Workspace write region

resourceCountsobject

Per-resource counts (agents, functions, models, sandboxes, policies, jobs, volumes, drives, volumetemplates, integrationconnections, previews, customdomains, serviceaccounts, images). Only populated when GetWorkspace is called with ?countResources=true.

Workspace status (created, account_binded, account_configured, workspace_configured, ready, error)

statusReasonstring

Reason for current status (only set for error status)

Example request

{
  "displayName": "My Workspace",
  "groupMappings": [
    {
      "groupName": "Engineering",
      "role": "admin"
    }
  ],
  "name": "my-workspace",
  "region": "us-west-2",
  "runtime": {
    "generation": "mk3"
  },
  "status": "ready"
}

Response

successful operation