Skip to main content

Back up the config to the destinations now

POST 
/config/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" \
  "https://$HOSERVA_HOST:8008/api/v1/config/backup"

Queues a config_backup job (service class): the config archive the nightly chain writes, taken now. It writes one archive to every enabled backup destination, verifies it, and prunes each destination's own retention, counting the archive like a scheduled one — it never takes the slot of a pre-import, pre-update or pre-topology archive. It is serialized with the other config backups, so one asked for while another runs queues rather than failing. The job succeeds when at least one destination was written and its log names each destination written and each that failed (the stale-destination alert covers one that keeps failing), and fails, with a config_backup_failed notification, when none was. Refused with 409 backup_no_destination before anything is queued while no destination is enabled, and with 501 not_configured when this daemon has no backup service. To download an archive instead of writing one to the destinations, use exportConfig.

Responses​

The queued or running config backup job.