/api/v1/admin/backup (PUT)

PUT

/api/v1/admin/backup

curl --request PUT \
  --url https://example.com/api/v1/admin/backup \
  --header 'Content-Type: application/json' \
  --data '{ "target": { "kind": "dir", "path": "example" }, "password": "example", "time": "example", "keep": { "daily": 1, "weekly": 1, "monthly": 1 } }'

Request Body^required

Media typeapplication/json

object

target

required

One of:

object

object

kind

required

string

Allowed values: dir

path

required

string

>= 2 characters <= 1024 characters

object

object

kind

required

string

Allowed values: s3

endpoint

Any of:

string

string format: uri

<= 2048 characters

null

null

region

string

default: us-east-1 >= 1 characters <= 64 characters

bucket

required

string

>= 3 characters <= 63 characters /^[a-z0-9][a-z0-9.-]*[a-z0-9]$/

prefix

string

default: kept-backups/ <= 512 characters /^(?:[A-Za-z0-9._-]+\/)*$/

forcePathStyle

boolean

accessKeyId

required

string

>= 1 characters <= 256 characters

secretAccessKey

string

>= 1 characters <= 1024 characters

object

object

kind

required

string

Allowed values: sftp

host

required

string

>= 1 characters <= 253 characters /^[A-Za-z0-9.:[\]-]+$/

port

integer

default: 22 >= 1 <= 65535

user

required

string

>= 1 characters <= 64 characters /^[A-Za-z0-9._-]+$/

path

required

string

>= 1 characters <= 1024 characters

privateKey

string

<= 16384 characters

hostKey

required

string

/^[a-z0-9][a-z0-9@.-]{2,63} [A-Za-z0-9+/]{16,8192}={0,3}$/

password

string

>= 1 characters <= 1024 characters

time

required

string

/^(?:[01]\d|2[0-3]):[0-5]\d$/

keep

required

object

daily

required

integer

>= 1 <= 366

weekly

required

integer

<= 260

monthly

required

integer

<= 120

Responses

200

Default Response