ReferenceAPICategories
Builds
Build lifecycle — queue, list, detail, cancel.
Returns builds, optionally filtered by project, pipeline, or status.
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Query Parameters
limit?integer
Page size (default 50)
Format
int64offset?integer
Page offset (default 0)
Format
int64project_id?string
Filter by project
pipeline_id?string
Filter by pipeline
status?string
Filter by one status or up to 9 comma-separated statuses
sort?string
Sort by created_at, status, project_name, pipeline_name, or branch
direction?string
Sort direction: asc or desc
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/builds"{ "builds": [ { "branch": "string", "build_number": 0, "changelog": "string", "commit_sha": "string", "config_snapshot": {}, "context": null, "created_at": 0, "exit_code": 0, "finished_at": 0, "id": "string", "pipeline_id": "string", "project_id": "string", "queued_at": 0, "runner_id": "string", "runner_policy_block_reason": null, "source_build_id": "string", "started_at": 0, "status": "queued", "step_results": [ { "duration_ms": 0, "exit_code": 0, "finished_at": 0, "name": "string", "started_at": 0, "status": "string" } ], "trigger_actor": "string", "trigger_event": "string", "trigger_ref": "string", "trigger_type": "manual", "updated_at": 0 } ], "total": 0}Authorization
bearer_auth AuthorizationBearer <token>
In: header
Path Parameters
build_id*string
Build ID
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/builds/string"{ "build": { "branch": "string", "build_number": 0, "changelog": "string", "commit_sha": "string", "config_snapshot": {}, "context": null, "created_at": 0, "exit_code": 0, "finished_at": 0, "id": "string", "pipeline_id": "string", "project_id": "string", "queued_at": 0, "runner_id": "string", "runner_policy_block_reason": null, "source_build_id": "string", "started_at": 0, "status": "queued", "step_results": [ { "duration_ms": 0, "exit_code": 0, "finished_at": 0, "name": "string", "started_at": 0, "status": "string" } ], "trigger_actor": "string", "trigger_event": "string", "trigger_ref": "string", "trigger_type": "manual", "updated_at": 0 }, "events": [ { "actor": "string", "build_id": "string", "created_at": 0, "from_status": "string", "id": "string", "reason": "string", "to_status": "string" } ]}Cancels a queued or running build.
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Path Parameters
build_id*string
Build ID
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/builds/string/cancel"{ "build": { "branch": "string", "build_number": 0, "changelog": "string", "commit_sha": "string", "config_snapshot": {}, "context": null, "created_at": 0, "exit_code": 0, "finished_at": 0, "id": "string", "pipeline_id": "string", "project_id": "string", "queued_at": 0, "runner_id": "string", "runner_policy_block_reason": null, "source_build_id": "string", "started_at": 0, "status": "queued", "step_results": [ { "duration_ms": 0, "exit_code": 0, "finished_at": 0, "name": "string", "started_at": 0, "status": "string" } ], "trigger_actor": "string", "trigger_event": "string", "trigger_ref": "string", "trigger_type": "manual", "updated_at": 0 }}Creates a new build cloning the original build's config_snapshot, branch, and commit_sha.
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Path Parameters
build_id*string
Source build ID to re-run
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/builds/string/rerun"{ "build": { "branch": "string", "build_number": 0, "changelog": "string", "commit_sha": "string", "config_snapshot": {}, "context": null, "created_at": 0, "exit_code": 0, "finished_at": 0, "id": "string", "pipeline_id": "string", "project_id": "string", "queued_at": 0, "runner_id": "string", "runner_policy_block_reason": null, "source_build_id": "string", "started_at": 0, "status": "queued", "step_results": [ { "duration_ms": 0, "exit_code": 0, "finished_at": 0, "name": "string", "started_at": 0, "status": "string" } ], "trigger_actor": "string", "trigger_event": "string", "trigger_ref": "string", "trigger_type": "manual", "updated_at": 0 }}Queues a new build for the specified project.
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Path Parameters
project_id*string
Project ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/string/builds" \ -H "Content-Type: application/json" \ -d '{ "pipeline_id": "string" }'{ "build": { "branch": "string", "build_number": 0, "changelog": "string", "commit_sha": "string", "config_snapshot": {}, "context": null, "created_at": 0, "exit_code": 0, "finished_at": 0, "id": "string", "pipeline_id": "string", "project_id": "string", "queued_at": 0, "runner_id": "string", "runner_policy_block_reason": null, "source_build_id": "string", "started_at": 0, "status": "queued", "step_results": [ { "duration_ms": 0, "exit_code": 0, "finished_at": 0, "name": "string", "started_at": 0, "status": "string" } ], "trigger_actor": "string", "trigger_event": "string", "trigger_ref": "string", "trigger_type": "manual", "updated_at": 0 }}Authorization
bearer_auth AuthorizationBearer <token>
In: header
Path Parameters
project_id*string
Project ID
Query Parameters
pipeline_id*string
Pipeline ID
branch?string
Target branch
commit_sha?string
Target commit
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/builds/changelog-preview?pipeline_id=string"{ "base_commit": "string", "markdown": "string", "target_commit": "string"}