Skip to Content
SeyloDocs

Delete a backup

POST
/api/v1/backups.deleteRun

Deletes a backup's object from the bucket and marks the run deleted. It can no longer be restored.

Needs backups.edit 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}$

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