List deployments

List the deployment history of a site, newest first.


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

List deployments

This endpoint returns the finished and scheduled deployments of a site. The site needs a repository. A deployment that is still running is not listed yet: follow it with Get deployment.

Optional parameters

  • Name
    per_page
    Type
    integer
    Description

    Deployments per page, 15 by default and at most 100.

  • Name
    page
    Type
    integer
    Description

    The page to fetch, 1 by default.

  • Name
    include_logs
    Type
    boolean
    Description

    Add the log output of each deployment as log_content.

Statuses

  • Name
    success
    Type
    status
    Description

    The deployment finished successfully.

  • Name
    failed
    Type
    status
    Description

    The deployment failed, the log shows why.

  • Name
    scheduled
    Type
    status
    Description

    The deployment is scheduled for a later moment.

  • Name
    cancelled
    Type
    status
    Description

    The scheduled deployment was cancelled.

Request

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

Response

{
  "data": [
    {
      "id": "9b2f6c1e-4d3a-4f8b-a7e2-1c5d9e0f3a6b",
      "status": "success",
      "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"
    }
  ],
  "meta": {
    "total": 1,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1
  }
}