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.
openapi/harthelm.yaml at v1.5.0__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.
ws*integerNumeric resource id.
int641 <= valueIdempotency-Key?stringClient-chosen key (at most 255 characters); a repeated key returns the first result for 24 h.
1 <= length <= 255Accepted; follow the Operation.
application/json- response
A long-running action. It ends in succeeded or failed and stays readable for 7 days.
id*stringuuidkind*stringWhat runs, for example workspace.create, workspace.delete, workspace.restore,
workspace.volume_owner, landscape.sync, landscape.teardown, workspace.archive,
workspace.restore_archive, managed_service.dump.
state*OperationState"pending""running""succeeded""failed"target?stringAPI path of the resource the operation acts on, e.g. /workspaces/123.
detail?stringHuman-readable progress, e.g. "Cloning repository".
error?RFC 9457 problem details.
created_at*stringdate-timeupdated_at*stringdate-timefinished_at?stringdate-timecurl -X POST 'https://console.example.com/api/v1/workspaces/1/archives'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "state": "pending", "target": "string", "detail": "string", "error": { "type": "about:blank", "title": "string", "status": 100, "detail": "string", "instance": "string", "errors": [ { "pointer": "string", "line": 1, "column": 1, "message": "string", "code": "string", "subject": "string" } ], "held_by_deleted": { "workspaces": 0, "storage_gib": 0 }, "failed_team": { "id": 1, "name": "string", "reason": "string" } }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z"}