Skip to Content
SeyloDocs

Add a backup destination

POST
/api/v1/backups.createDestination

Adds an S3-compatible bucket (AWS S3, Cloudflare R2, MinIO) for backups. Run backups.testDestination first to check the keys.

Needs backups.destinations, which owners and admins hold. Not available to MCP clients or the assistant.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
name*string
Length1 <= length <= 60
provider*string|string|string|string
endpoint*string
Match^https?://
Length8 <= length <= 500
region*string
Length1 <= length <= 60
Default"auto"
bucket*string
Match^[a-z0-9][a-z0-9.-]*[a-z0-9]$
Length3 <= length <= 63
pathPrefix*string
Match^([^/][^\\]*)?$
Lengthlength <= 200
Default""
pathStyle*boolean
Defaultfalse
accessKeyId*string
Length1 <= length <= 200
secretAccessKey*string
Length1 <= length <= 500

Response Body

Success.

application/json
  1. response
id*string

Panel-issued id.

Match^[a-z0-9]{16}$
name*string
Length1 <= length <= 60
provider*string|string|string|string
endpoint*string
Match^https?://
Length8 <= length <= 500
region*string
Length1 <= length <= 60
Default"auto"
bucket*string
Match^[a-z0-9][a-z0-9.-]*[a-z0-9]$
Length3 <= length <= 63
pathPrefix*string
Match^([^/][^\\]*)?$
Lengthlength <= 200
Default""
pathStyle*boolean
Defaultfalse
accessKeyId*string
Length1 <= length <= 200
policyCount*integer
Range0 <= value
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X POST 'https://example.com/api/v1/backups.createDestination' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "provider": "s3",  "endpoint": "stringst",  "region": "auto",  "bucket": "string",  "pathPrefix": "",  "pathStyle": false,  "accessKeyId": "string",  "secretAccessKey": "string"}'
Example Response
{  "id": "string",  "name": "string",  "provider": "s3",  "endpoint": "stringst",  "region": "auto",  "bucket": "string",  "pathPrefix": "",  "pathStyle": false,  "accessKeyId": "string",  "policyCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}