Skip to main content
NookDocs
Dashboard

Deployments

Trigger a deployment

Manually trigger a fresh sync from the connected GitHub repo. Use this when you need to rebuild without pushing a new commit (e.g. after rotating secrets).

POST/projects/{id}/deployments
Trigger a deployment
curl --request POST \
  --url 'https://api.nookdocs.com/v1/projects/{id}/deployments' \
  --header 'Authorization: Bearer <token>'
{
  "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

Response

application/json

Deployment queued

idstring (uuid)required
statusenum<string>required
options:queuedbuildingdeployedfailed
commit_shastring
Git commit SHA that triggered the deployment
project_idstring (uuid)required
started_atstring (date-time)required
finished_atstring (date-time)
Null while the deployment is still in progress
pages_totalinteger
Total page count for this deployment
pages_failedinteger
Pages that failed during sync
pages_successinteger
Pages successfully synced