Skip to main content

Start an appdata backup

POST 
/appdata/backup

Required role: admin. Only an account or token with the admin role can call this operation.

Example request
curl --request POST \
  --header "Authorization: Bearer $HOSERVA_TOKEN" \
  --header "Content-Type: application/json" \
  --data @body.json \
  "https://$HOSERVA_HOST:8008/api/v1/appdata/backup"

Queues an appdata_backup job (service class): every container that is running and set to be stopped is stopped, each included container's appdata directories are archived, one archive per container, on the same device as the appdata location, the stopped containers are started again in reverse order, and only then are the archives verified and written to the enabled backup destinations (never the boot device's default destination, which is too small for appdata). containers limits the run to the named containers; omit it for every included one. Refused with 409 array_stopped while the array is stopped or its storage is not ready — with the cache disk unmounted the appdata directories are empty — and 404 container_not_found for a name that is not in scope. A run that fails publishes an appdata_backup_failed notification.

Request​

Responses​

The queued or running appdata backup job.