Bqckup Remote Storage

Remote Storage

For better security, storage credentials can be stored separately and retrieved via a RESTful API. To enable this feature, add the following configuration:

/etc/bqckup/config/storages.yml

storages:
  dummy:
+   remote_url: https://domain.com/api/get?token=894211610151115239

Ensure that the target URL follows the specifications below.

Method: GET

404: Not Found

200: OK

{
    "bucket": "string",
    "access_key_id": "string",
    "secret_access_key": "string",
    "endpoint": "string|url",
    "region": "string"
}

Backup Notification

After completing a backup and after_backup_completed configuration is set, bqckup will send relevant backup data to url.

Ensure that the target URL follows the specifications below.

Method: POST

Body:

{
    "domain": "string|required",
    "hostname": "string|required",
    "total_size": "integer64|required", // -1 for not changed
    "size": "integer64|required",
    "start_at": "integer64|required",
    "finish_at": "integer64|required",
    "status": "string|enum[failed, completed]|required",
    "backup_method": "string|enum[tar, incremental]|required"
}

201: Create Success

Webhook configuration:

/etc/bqckup/bqckup.cnf

[webhooks]
after_backup_completed=

General API Error

400: Bad Request

401: Unauthorized

{
    "error": "string",
    "message": "string"
}