Harthelm Docs
REST APIManaged services

Dump a managed service now

Needs `team.managed_services`, for a bound instance also `landscape.manage` on its workspace. Runs the nightly dump of this one instance now: a Job of the backup role writes a `pg_dump` to the backup volume (`ms/<team>/<object name>-<id>/`, `<id>` the first 12 hex digits of the instance's id), recorded like the nightly runs and kept by the same retention. Follow the Operation (kind `managed_service.dump`). 409 `backups-disabled` when the installation has no backup volume or the provider cannot back up, `managed-service-paused` while paused.

Generated from openapi/harthelm.yaml at v1.5.0
POST
/managed-services/{ms}/dump

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

ms*string

A managed service's id.

Formatuuid

Response Body

Accepted; follow the Operation.

application/json
  1. response

A long-running action. It ends in succeeded or failed and stays readable for 7 days.

id*string
Formatuuid
kind*string

What 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
Value in"pending""running""succeeded""failed"
target?string

API path of the resource the operation acts on, e.g. /workspaces/123.

detail?string

Human-readable progress, e.g. "Cloning repository".

error?

RFC 9457 problem details.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
finished_at?string
Formatdate-time
curl -X POST 'https://console.example.com/api/v1/managed-services/497f6eca-6276-4993-bfeb-53cbbbba6f08/dump'
{  "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"}

Delete a managed service and its data

Needs `team.managed_services`. Soft delete: the status goes `deleting` while the backend removes the server and its volume, then `deleted`; the row stays listed as recently deleted (`include_deleted`) for `marketplace.tombstoneDays`. The data is gone; the last nightly dump is the final copy (a dump on delete comes later). The console asks for the name first. An instance bound to a landscape: 409 `managed-service-bound` (remove it from `harthelm.yml` and Sync). Deleting a deleting or deleted instance answers its current state.

Get a managed service

Needs `team.view` on its team. Tombstones stay readable until they are purged.