Skip to Content
SeyloDocs
API referenceDeployments

Get a deployment

GET
/api/v1/deployments.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.

Authorization

cookieseylo_session<token>

Query Parameters

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
deployment*
logTopic*string
Example Request
curl -X GET 'https://example.com/api/v1/deployments.get?serviceId=string&deploymentId=string'
Example Response
{  "deployment": {    "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"  },  "logTopic": "string"}

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.

List a service's deployments GET

Lists a service's deploy history, newest first: status, who or what triggered it, commit, where it was built and shipped, image digest, step durations, and whether it can be rolled back to. Needs `services.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.