Deployments

Deployments represent the process of building and deploying your projects to servers. Each deployment contains information about the build status, logs, and timing. On this page, we will dive into the different deployment endpoints you can use to manage deployments programmatically.

POST/api/v1/deployments

Create deployment

This endpoint allows you to trigger deployments for multiple projects at once. This is useful for deploying related projects simultaneously. You can also trigger a deployment for a single project.

Attributes for creating a deployment

Name
project_ids
Type
array
Description
An array of project IDs to deploy. Example: [1, 2, 3].

Request

POST

/api/v1/deployments

curl https://app.depfloy.com/api/v1/deployments \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "project_ids": [1, 2, 3]
  }'

Response

{
    "message": "Deployment queued successfully.",
    "status": "success"
}

GET/api/v1/projects/:id/deployments

List project deployments

This endpoint allows you to retrieve a paginated list of all deployments for a specific project.

Optional attributes

Name
per_page
Type
integer
Description
Limit the number of deployments returned per page. Default is 15.
Name
page
Type
integer
Description
The page number to retrieve.

Request

GET

/api/v1/projects/1/deployments

curl -G https://app.depfloy.com/api/v1/projects/1/deployments \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Accept: application/json"

Response

{
    "current_page": 1,
    "data": [
        {
            "id": 5,
            "tenant_id": 1,
            "project_id": 1,
            "initiated_by": 1,
            "git_branch": "master",
            "commit_id": null,
            "commit_url": null,
            "description": "Deployment started from API",
            "status": 0,
            "duration": 0,
            "created_at": "2026-01-17T13:55:31.000000Z",
            "updated_at": "2026-01-17T13:55:31.000000Z"
        },
        {
            "id": 1,
            "tenant_id": 1,
            "project_id": 1,
            "initiated_by": 1,
            "git_branch": "master",
            "commit_id": null,
            "commit_url": null,
            "description": "Deployment started by Maggy",
            "status": 1,
            "duration": 100,
            "created_at": "2025-05-26T06:59:26.000000Z",
            "updated_at": "2025-05-26T10:29:20.000000Z"
        }
    ],
    "per_page": 10,
    "total_items": 2,
    "total_pages": 1
}

GET/api/v1/deployments/:id

Retrieve a deployment

This endpoint allows you to retrieve a specific deployment by its ID. This includes the full build log.

Request

GET

/api/v1/deployments/:id

curl https://app.depfloy.com/api/v1/deployments/5334 \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Accept: application/json"

Response

{
    "id": 1,
    "project_id": 1,
    "initiated_by": 1,
    "git_branch": "master",
    "commit_id": null,
    "commit_url": null,
    "description": "Deployment started by Maggy",
    "status": 1,
    "duration": 100,
    "created_at": "2025-05-26T06:59:26.000000Z",
    "updated_at": "2025-05-26T10:29:20.000000Z",
    "output": {
        "process_type": "build",
        "client_payload": [
            // ... client payload
            "✓ 1 asset moved from React Router server build to client assets.",
            "✓ built in 23.73s\n",
            "07:01:09 - ✓ Deployment completed."
        ],
        "system_payload": [
          // ... system payload
        ]
    }
}