Skip to Content
SeyloDocs
API referenceBackups

Restore a backup

POST
/api/v1/backups.restore

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.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
serviceId*string

Panel-issued id.

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

Panel-issued id.

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

Must equal the service's name.

backupFirst?boolean

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.restore' \  -H 'Content-Type: application/json' \  -d '{  "serviceId": "string",  "runId": "string",  "confirmName": "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"}

List backup runs GET

Lists a service's backup and restore runs, newest first, 50 per page. Pass the last run's startedAt as before for the next page. Needs `backups.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.

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.