Harthelm Docs
REST APIBackups

Get an archive

Needs `team.view` on the archive's team; pruned archives stay readable with `restorable` false.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/archives/{archive}

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Path Parameters

archive*integer

Numeric resource id.

Formatint64
Range1 <= value

Response Body

The archive.

application/json
  1. response
id*ID

Numeric resource id.

Formatint64
Range1 <= value
team_id*ID

Numeric resource id.

Formatint64
Range1 <= value
workspace_id*ID

Numeric resource id.

Formatint64
Range1 <= value
workspace_name*string
plan*string

The workspace's plan when it was archived.

base_image*string
git?
created_at*string
Formatdate-time
size_bytes*integer
Formatint64
Range0 <= value
restorable*boolean

False once retention removed the file.

curl -X GET 'https://console.example.com/api/v1/archives/1'
{  "id": 1,  "team_id": 1,  "workspace_id": 1,  "workspace_name": "string",  "plan": "string",  "base_image": "string",  "git": {    "provider": "string",    "repo": "string",    "ref": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "size_bytes": 0,  "restorable": true}

Archive a sleeping workspace now

Needs `workspace.settings`. Archives the workspace's volume now instead of at the nightly sweep. Archives are taken only while the IDE and every service sleep (problem `workspace-awake` otherwise; put the workspace to sleep first), and only when workspace backups are enabled (problem `backups-disabled`). Follow the Operation (kind `workspace.archive`). A wake while the archive runs wins: the run ends as failed and the archive is taken after the next sleep.

List the archives of a team

Needs `team.view`. Restorable archives of every workspace of the team, newest first, including workspaces that were deleted or purged since: this is where a deleted workspace is restored from.