Critical BackupUpdate Critical Backup

Update Critical Backup

Update the settings of an existing critical backup job.

curl -X POST "https://api.5centscdn.com/v2/cb/42" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "name": "Daily S3 Backup",
  "meta": {
    "prefix": "s3",
    "description": "",
    "access_key_id": "AKIAIOSFODNN7EXAMPLE"
  }
}'
{
  "result": "success",
  "message": "CriticalBackup updated"
}
POST
/cb/{backupid}
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key (sent in header)

path
backupidinteger
Required

Critical Backup job ID

Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Display name for the backup job. Required.

metaobject
Required

Provider configuration for the backup destination, in the same shape as the create endpoint. prefix identifies the storage provider - not limited to the providers offered at creation time, since a backup can be reassigned to any supported provider through this endpoint - and description is an optional free-text note; all other keys are provider-specific settings for the selected provider. For file or certificate type fields, leaving the field blank retains the value already stored on the backup rather than clearing it. Depending on the provider field's type, some of these keys are validated before submission: size-suffix fields must be a number optionally followed by B, K, M, G, T, or P, or the literal value off; duration fields must be a sequence of optional numeric components for years (y), months (M), weeks (w), days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms), for example 1h30m; URL fields must be a valid URL; JSON fields must contain valid JSON; and CSV fields must contain an even number of comma-separated values.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. Provide your API key in the header.

Path Parameters

backupidinteger
Required

Critical Backup job ID

Example:
42

Body

application/json
namestring
Required

Display name for the backup job. Required.

Example:
Daily S3 Backup
metaobject
Required

Provider configuration for the backup destination, in the same shape as the create endpoint. prefix identifies the storage provider - not limited to the providers offered at creation time, since a backup can be reassigned to any supported provider through this endpoint - and description is an optional free-text note; all other keys are provider-specific settings for the selected provider. For file or certificate type fields, leaving the field blank retains the value already stored on the backup rather than clearing it. Depending on the provider field's type, some of these keys are validated before submission: size-suffix fields must be a number optionally followed by B, K, M, G, T, or P, or the literal value off; duration fields must be a sequence of optional numeric components for years (y), months (M), weeks (w), days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms), for example 1h30m; URL fields must be a valid URL; JSON fields must contain valid JSON; and CSV fields must contain an even number of comma-separated values.

Example:
{"prefix":"s3","description":"","access_key_id":"AKIAIOSFODNN7EXAMPLE"}

Responses

resultstring

Status of the API response.

messagestring

Human-readable status or result message.