Skip to Content
SeyloDocs
API referenceDeployments

List a service's deployments

GET
/api/v1/deployments.list

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.

Authorization

cookieseylo_session<token>

Query Parameters

serviceId*string

Panel-issued id.

Match^[a-z0-9]{16}$
limit?integer
Range1 <= value <= 100
Default20
cursor?string
Lengthlength <= 100

Response Body

Success.

application/json
  1. response
deployments*array<>
nextCursor*string|null
keptImages*integer
Range0 <= value
Example Request
curl -X GET 'https://example.com/api/v1/deployments.list?serviceId=string'
Example Response
{  "deployments": [    {      "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"    }  ],  "nextCursor": "string",  "keptImages": 0}

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.

Read a deployment's log GET

Returns the build and deploy log of a deployment, oldest first, after a sequence number. done is true once the deployment finished and every line has been returned. Build logs are read from the node that built. Needs `services.view` on the service (a grant on its project covers it). Available to MCP clients and the assistant.