sdkDeterministic

Delete workspace

pipeline.deleteWorkspace

Permanently delete one exact workspace owned by the authenticated personal-token user. Requires confirm=true. This cannot be undone.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

targetWorkspaceIdrequired

string

Exact workspace to delete. This is never replaced by the workspace selected for authentication.

confirmrequired

boolean

No description.

TypeScripttypescript

await pipeline.deleteWorkspace({
  "targetWorkspaceId": "00000000-0000-4000-8000-000000000000",
  "confirm": true
})

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ]
}

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.