Skip to Content
SeyloDocs
API referenceBackups

Change a backup destination

POST
/api/v1/backups.updateDestination

Changes a destination. Fields left out keep their value, including the secret key. Existing backups stay where they were written.

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
destinationId*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
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.updateDestination' \  -H 'Content-Type: application/json' \  -d '{  "destinationId": "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"}

Test a backup destination POST

Writes, reads and deletes a small test object to check the endpoint, bucket and keys. Test a saved destination by id, or unsaved settings with draft (a draft without secretAccessKey reuses the saved key of destinationId). Needs `backups.destinations`, which owners and admins hold. Not available to MCP clients or the assistant.

Change a backup schedule POST

Changes a schedule's destination, timing, retention or on/off state. Fields left out keep their value. Needs `backups.edit` on the service (a grant on its project covers it). Available to MCP clients and the assistant.