Skip to Content
SeyloDocs
API referenceBackups

Test a backup destination

POST
/api/v1/backups.testDestination

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.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
destinationId?string

Panel-issued id.

Match^[a-z0-9]{16}$
draft?

Response Body

Success.

application/json
  1. response
ok*boolean
failedStep*string|null
message*string
latencyMs*|null
Example Request
curl -X POST 'https://example.com/api/v1/backups.testDestination' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "ok": true,  "failedStep": "string",  "message": "string",  "latencyMs": 0}

Back up now POST

Starts a backup right away: of a schedule (policyId), or a one-off of the database or a volume to a destination. Returns the run; follow it with backups.listRuns or the live service topic. Needs `backups.run` on the service (a grant on its project covers it). Available to MCP clients and the assistant.

Change a backup destination POST

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.