Critical BackupCreate Critical Backup

Create Critical Backup

Create a new critical backup job.

curl -X POST "https://api.5centscdn.com/v2/cb" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "_METHOD": "PUT",
  "name": "Daily S3 Backup",
  "meta": {
    "prefix": "s3",
    "description": "",
    "access_key_id": "AKIAIOSFODNN7EXAMPLE",
    "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  }
}'
{
  "result": "success",
  "message": "CriticalBackup added. Please link Push Zones & configure for periodic backups",
  "backupid": 129017
}
POST
/cb
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)

Content-Typestring
Required

The media type of the request body

Options: application/json
_METHODstring
Required

HTTP method override for this request. Always set to PUT to create a new backup.

namestring
Required

Display name for the backup job. Required.

metaobject
Required

Provider configuration for the backup destination. prefix selects the storage provider and determines which other keys apply; description is an optional free-text note. All other keys are provider-specific credential and connection fields defined by the selected provider - for example ftp requires host (and accepts user, port, pass, tls, and other connection settings), http requires url, sftp requires host, s3 requires access_key_id and secret_access_key, and b2 requires account and key. Only ftp, http, sftp, s3, b2, storj, and koofr can be selected when creating a new backup; other supported providers can be assigned afterwards via the update endpoint. 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.

Body

application/json
_METHODstring
Required

HTTP method override for this request. Always set to PUT to create a new backup.

Example:
PUT
namestring
Required

Display name for the backup job. Required.

Example:
Daily S3 Backup
metaobject
Required

Provider configuration for the backup destination. prefix selects the storage provider and determines which other keys apply; description is an optional free-text note. All other keys are provider-specific credential and connection fields defined by the selected provider - for example ftp requires host (and accepts user, port, pass, tls, and other connection settings), http requires url, sftp requires host, s3 requires access_key_id and secret_access_key, and b2 requires account and key. Only ftp, http, sftp, s3, b2, storj, and koofr can be selected when creating a new backup; other supported providers can be assigned afterwards via the update endpoint. 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","secret_access_key":"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}

Responses

resultstring

Status of the API response.

messagestring

Human-readable status or result message.

backupidinteger

The ID of the newly created backup job.