Deployments

Monitor and manage application deployments. Every time an application is deployed (manually, via API, or via Git webhook), a deployment record is created.

List Deployments

Returns recent deployments across all applications in the current team.

GET /api/v1/deployments

Response:

{
  "data": [
    {
      "uuid": "deploy-abc123",
      "application_uuid": "app-abc123",
      "application_name": "my-web-app",
      "status": "finished",
      "commit": "a1b2c3d",
      "commit_message": "Update landing page",
      "branch": "main",
      "created_at": "2024-06-15T14:30:00Z",
      "finished_at": "2024-06-15T14:32:45Z"
    }
  ]
}

Deployment Statuses

Status	Description
queued	Deployment is waiting to start
in_progress	Build or deployment is running
finished	Deployment completed successfully
failed	Deployment failed (check logs)
cancelled	Deployment was cancelled

Get Deployment Details

GET /api/v1/deployments/{uuid}

Returns full deployment details including build logs:

{
  "uuid": "deploy-abc123",
  "application_uuid": "app-abc123",
  "status": "finished",
  "commit": "a1b2c3d",
  "branch": "main",
  "logs": "Building application...\n[nixpacks] Detected Node.js...\n...",
  "created_at": "2024-06-15T14:30:00Z",
  "started_at": "2024-06-15T14:30:05Z",
  "finished_at": "2024-06-15T14:32:45Z"
}

List Application Deployments

Get deployment history for a specific application:

GET /api/v1/deployments/applications/{application_uuid}

Returns deployments sorted by most recent first.

Cancel Deployment

Cancel a running or queued deployment:

POST /api/v1/deployments/{uuid}/cancel

Response:

{
  "message": "Deployment cancelled."
}

note

Only deployments with status queued or in_progress can be cancelled. Cancelling a finished deployment returns a 400 error.

Triggering Deployments

To trigger a new deployment, use the Applications API:

POST /api/v1/applications/{uuid}/deploy

Webhook Deployments

Applications connected via GitHub App automatically deploy on push to the configured branch. You can also configure manual webhook URLs for other Git providers.