Skip to main content

Deployments

List deployments

Returns the deployment history for a project, newest first. Use the status filter to find failed builds.

GET/projects/{id}/deployments
List deployments
curl --request GET \
  --url 'https://api.nookdocs.com/v1/projects/{id}/deployments' \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "queued",
      "commit_sha": "<string>",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "pages_total": 123,
      "pages_failed": 123,
      "pages_success": 123
    }
  ]
}

Authorizations

Authorizationstringheaderrequired

API key issued from your dashboard (Settings → API Keys). Format: nook_... — pass as Authorization: Bearer nook_.... Keys carry scopes (projects:read/write, pages:read, deployments:read/trigger, analytics:read) — calls without the required scope return 403.

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

idstring (uuid)pathrequired

Query parameters

statusenum<string>query
Filter by deployment status
options:queuedbuildingdeployedfailed
limitintegerquerydefault: 20

Response

application/json

Array of deployments

dataobject[]