Manage Backup Configuration

HTTP Methods and URIs

Get the current rotation configuration:

GET /api/v1/config

Apply a new configuration:

POST /api/v1/config

Table 1. POST Parameter
Name	Description	Schema
`history_rotation_size`	The maximum size of the backup history can grow to before the Backup Service starts removing older history.	Integer value between 5 and 200

Curl Syntax

curl -X GET http://$BACKUP_SERVICE_NODE:$BACKUP_SERVICE_PORT/api/v1/config
  -u $USERNAME:$PASSWORD

curl -X POST http://$BACKUP_SERVICE_NODE:$BACKUP_SERVICE_PORT/api/v1/config
  -u $USERNAME:$PASSWORD
  -d '{"history_rotation_size":$HISTORY_ROTATION_SIZE}'

Required Permissions

To call this method via GET: Full Amin, Backup Admin, or Read-Only Admin.

To call this method via POST: Full Admin or Backup Admin.

Responses

Value Description

Value	Description
`200 OK` and when calling via GET, a JSON object containing the current settings.	Successful call.
`400 Bad Request` plus the JSON message `{ "status": 400, "msg": "Rotation size has to be between 5 and 200"}`	Returned when trying to set the rotation size to an invalid value.
`401 Unauthorized`	Authorization failure due to incorrect username or password.
`403 Forbidden`, plus a JSON message explaining the minimum permissions.	The provided username has insufficient privileges to call this method.

200 OK and when calling via GET, a JSON object containing the current settings.

Successful call.

400 Bad Request plus the JSON message { "status": 400, "msg": "Rotation size has to be between 5 and 200"}

Returned when trying to set the rotation size to an invalid value.

401 Unauthorized

Authorization failure due to incorrect username or password.

403 Forbidden, plus a JSON message explaining the minimum permissions.

The provided username has insufficient privileges to call this method.

Examples

The following call returns the current configuration limits:

curl -v -X GET http://127.0.0.1:8097/api/v1/config \
-u Administrator:password

If successful, the call returns 200 OK, and the following object:

{"history_rotation_size":50}

The following call modifies the rotation size:

curl -v -X POST http://127.0.0.1:8097/api/v1/config -u Administrator:password \
-d '{"history_rotation_size":51}'

Success returns 200 OK.