Skip to Content
SeyloDocs
API referenceDeployments

Deploy a service now

POST
/api/v1/deployments.deploy

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.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$
commitSha?string
Match^[0-9a-f]{7,64}$
noCache?boolean

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

Cancel a deployment POST

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.

Get a deployment GET

Returns one deployment with its steps. While it runs, subscribe to logTopic on the live socket for new log lines, or poll deployments.log with afterSeq. Needs `services.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.