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

Authorization

Requires: BearerAuth

Path parameters

idstring (uuid)pathrequired

Response

202 — Deployment queued

idstring (uuid)required

statusenum (queued, building, deployed...)required

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

409 — A deployment is already in progress for this project

errorstringrequired

Machine-readable error code (e.g. `invalid_request`, `unauthorized`, `not_found`)

messagestringrequired

Human-readable error description

Trigger a deployment

curl --request POST \
  --url 'https://api.codivdocs.com/v1/projects/{id}/deployments' \
  --header 'Authorization: Bearer <token>'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "queued",
  "commit_sha": "<string>",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "started_at": "2026-04-13T03:28:13.756Z",
  "finished_at": "2026-04-13T03:28:13.756Z",
  "pages_total": 0,
  "pages_failed": 0,
  "pages_success": 0
}