Get deployment

Get the status of a single deployment, for example the one you just started.


GET/api/servers/{server}/sites/{site}/deployments/{deployment}

Get deployment

Deploying a site returns a deployment_id. Poll this endpoint with it to follow the deployment: the status is deploying while it runs, and success or failed once it finished. A finished deployment links to its output in log_url, see Get deployment log.

While the deployment runs, only id and status are filled in. The other fields follow once it finished.

Returns a 404 when the deployment does not exist or belongs to another site.

Request

GET
/api/servers/{server}/sites/{site}/deployments/{deployment}
curl -G "https://ploi.io/api/servers/{server}/sites/{site}/deployments/{deployment}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Response (running)

{
  "data": {
    "id": "9b2f6c1e-4d3a-4f8b-a7e2-1c5d9e0f3a6b",
    "status": "deploying",
    "commit_hash": null,
    "commit_message": null,
    "source": null,
    "human_source": null,
    "created_at": null,
    "log_id": null,
    "log_url": null
  }
}

Response (finished)

{
  "data": {
    "id": "9b2f6c1e-4d3a-4f8b-a7e2-1c5d9e0f3a6b",
    "status": "failed",
    "commit_hash": "f3c9a1b",
    "commit_message": "Fix the checkout total",
    "source": "api",
    "human_source": "API",
    "created_at": "2026-11-11 14:02:51",
    "log_id": 482913,
    "log_url": "https://ploi.io/api/servers/1/sites/2/deployments/9b2f6c1e-4d3a-4f8b-a7e2-1c5d9e0f3a6b/log"
  }
}