Skip to Content
SeyloDocs
API referenceDeployments

Cancel a deployment

POST
/api/v1/deployments.cancel

Cancels a queued, building or deploying deployment. A new version that was already started is removed; the live version keeps serving. Finished deployments cannot be cancelled.

Needs services.deploy 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}$
deploymentId*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}$
serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$
generation*integer
Range1 <= value
status*string|string|string|string|string|string|string
live*boolean
trigger*string|string|string|string|string|string|string|string
actor*string|null
commit*|null
builder*string|string|string|null
builtOn*|null
shippedTo*array<>
image*|null
steps*array<>
durationMs*|null
canRollback*boolean
rollbackOf*|null
error*string|null
createdAt*string
Formatdate-time
startedAt*|null
finishedAt*|null
Example Request
curl -X POST 'https://example.com/api/v1/deployments.cancel' \  -H 'Content-Type: application/json' \  -d '{  "serviceId": "string",  "deploymentId": "string"}'
Example Response
{  "id": "string",  "serviceId": "string",  "generation": 1,  "status": "queued",  "live": true,  "trigger": "manual",  "actor": "string",  "commit": {    "sha": "string",    "message": "string",    "branch": "string",    "author": "string"  },  "builder": "railpack",  "builtOn": {    "id": "string",    "name": "string"  },  "shippedTo": [    {      "id": "string",      "name": "string"    }  ],  "image": {    "reference": "string",    "digest": "string",    "sizeBytes": 0,    "shippedBytes": 0  },  "steps": [    {      "key": "clone",      "status": "pending",      "node": {        "id": "string",        "name": "string"      },      "detail": "string",      "durationMs": 0    }  ],  "durationMs": 0,  "canRollback": true,  "rollbackOf": "string",  "error": "string",  "createdAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "finishedAt": "2019-08-24T14:15:22Z"}

Create or rotate a deploy trigger URL POST

Creates a new secret deploy URL for a service and invalidates the old one. A POST to the URL deploys the service (optional query: commit=<sha>). The URL is returned only this once. While the panel has no domain it is a path (/api/hooks/deploy/...) to put after the panel's address. Needs `services.update` on the service (a grant on its project covers it). Not available to MCP clients or the assistant.

Deploy a service now POST

Starts a deploy of the service's current settings: the branch head (or a given commit) for git sources, the image for image sources. Queued behind a running deploy of the same service. Returns the new deployment; follow it with deployments.get and deployments.log. Needs `services.deploy` on the service (a grant on its project covers it). Available to MCP clients and the assistant.