Archive a workspace

$ boltz-api admin:workspaces archive

POST/compute/v1/admin/workspaces/{workspace_id}/archive

Archives a workspace and deactivates all its API keys. This action is irreversible.

ParametersExpand Collapse

--workspace-id: string

ReturnsExpand Collapse

AdminWorkspaceArchiveResponse: object { id, archived_at, created_at, 4 more }

id: string

Workspace ID

archived_at: string

formatdate-time

created_at: string

formatdate-time

data_retention: object { unit, value }

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

unit: "hours" or "days"

Time unit for retention duration

Accepts one of the following:

"hours"

"days"

value: number

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

is_default: boolean

Whether this is the default workspace

name: string

Workspace name

updated_at: string

formatdate-time

Archive a workspace

boltz-api admin:workspaces archive \
  --workspace-id workspace_id

{
  "id": "id",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data_retention": {
    "unit": "hours",
    "value": 1
  },
  "is_default": true,
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "id",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data_retention": {
    "unit": "hours",
    "value": 1
  },
  "is_default": true,
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z"
}