Skip to Content
SeyloDocs
API referenceBackups

Back up now

POST
/api/v1/backups.runNow

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.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
serviceId*string

Panel-issued id.

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

Panel-issued id.

Match^[a-z0-9]{16}$
target?string|string
volumeId?string

Panel-issued id.

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

Panel-issued id.

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

Response Body

Success.

application/json
  1. response
id*string

Panel-issued id.

Match^[a-z0-9]{16}$
kind*string|string
serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$
policyId*|null
destinationId*|null
target*string|string
volumeId*|null
sourceRunId*|null
status*string|string|string
objectKey*string|null
sizeBytes*|null
error*string|null
deletedAt*|null
startedAt*string
Formatdate-time
finishedAt*|null
Example Request
curl -X POST 'https://example.com/api/v1/backups.runNow' \  -H 'Content-Type: application/json' \  -d '{  "serviceId": "string"}'
Example Response
{  "id": "string",  "kind": "backup",  "serviceId": "string",  "policyId": "string",  "destinationId": "string",  "target": "database",  "volumeId": "string",  "sourceRunId": "string",  "status": "running",  "objectKey": "string",  "sizeBytes": 0,  "error": "string",  "deletedAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "finishedAt": "2019-08-24T14:15:22Z"}

Restore a backup POST

Restores a successful backup over the service's current data (database or volume). Current data is replaced and cannot be recovered unless backed up first. The service name must be repeated to confirm. Needs `backups.restore` on the service (a grant on its project covers it). Available to MCP clients and the assistant, after a person approves the call.

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.