Harthelm Docs
REST APIBackups

List the archives of a workspace

Needs `workspace.view`. Restorable archives, newest first (pruned ones are not listed).

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

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

ws*integer

Numeric resource id.

Formatint64
Range1 <= value

Query Parameters

limit?integer

Maximum number of items per page.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from next_cursor of the previous page.

Lengthlength <= 1024

Response Body

A page of archives.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/workspaces/1/archives'
{  "next_cursor": "string",  "items": [    {      "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    }  ]}

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.

Restore an archive into a new workspace

Needs `team.create_workspace` on the archive's team. Creates a new workspace in that team with the archive's `/data/app` and tool store (`/data/tools`); env vars, secrets and the landscape are not part of an archive (Sync again). The new workspace starts asleep with sleep reason `restore` and wakes when its volume is filled; follow the Operation (kind `workspace.restore_archive`). Plan, base image, availability and restriction default to the archived workspace's; the origin repository goes on the new workspace's git access list as at creation. 409 `name-taken` like a create; 409 `backups-disabled`; 404 for a pruned archive.