Skip to content

Workspaces

Generated TypeScript Management SDK methods for Workspaces.

Updated View as Markdown
Audience: application-backendPlane: adminAuth: management-keyStatus: beta

These methods are generated from the Admin OpenAPI contract. They configure the control plane; they do not send model requests.

Method HTTP Path Reference
archiveWorkspace DELETE /admin/v1/workspaces/{workspaceId} API
createWorkspace POST /admin/v1/workspaces API
getWorkspace GET /admin/v1/workspaces/{workspaceId} API
listWorkspaces GET /admin/v1/workspaces API
updateWorkspace PATCH /admin/v1/workspaces/{workspaceId} API

Method signatures

archiveWorkspace

nexus.archiveWorkspace(
  input: AdminOperationInput<"archiveWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"archiveWorkspace">>

Archive a workspace

createWorkspace

nexus.createWorkspace(
  input: AdminOperationInput<"createWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createWorkspace">>

Create a workspace

getWorkspace

nexus.getWorkspace(
  input: AdminOperationInput<"getWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getWorkspace">>

Get a workspace

listWorkspaces

nexus.listWorkspaces(
  input: AdminOperationInput<"listWorkspaces">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listWorkspaces">>

List workspaces visible to the current management principal

updateWorkspace

nexus.updateWorkspace(
  input: AdminOperationInput<"updateWorkspace">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"updateWorkspace">>

Update a workspace

Navigation

Type to search…

↑↓ navigate↵ selectEsc close