List deployments

GET

/api/v1/deployments

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/deployments \
  --header 'Authorization: <Authorization>'

Returns a paginated list of deployments with optional filters

Authorizations

• BearerAuth

Parameters

Query Parameters

page

integer

Page number (default: 1)

page_size

integer

Items per page (default: 20, max: 100)

project_id

string

Filter by project ID (UUID)

status

string

Filter by status (pending, queued, building, deployed, failed, cancelled)

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

deployments

Array<object>

object

branch

string

build_finished_at

string

build_log

string

build_queued_at

BuildQueuedAt is when the build entered the queue. Subtract it from build_started_at for the queue wait.

string

build_started_at

string

commit_hash

string

commit_message

string

content_hash

ContentHash is the digest of the upload’s sorted manifest (path+hash pairs). Two uploads of identical content share it, which is what makes a re-upload a no-op.

string

created_at

string

created_by_email

string

deployed_at

string

error_category

ErrorCategory of a failed build: build_error, configuration, platform, timeout or platform_restart. Always a category, never a raw error message.

string

failure_signature

FailureSignature identifies this build’s classified failure (DEP-544): a truncated SHA-256 of stage, category and the classified error line. Equal signatures across a project’s deployments are “the same failure again”, which is what the auto-deploy circuit breaker counts. NULL for a successful or unclassified build.

string

failure_summary

FailureSummary is why this build failed and, when we know one, the settings change that would fix it (DEP-673, migration 000110). Written once with the failed status. nil for anything that did not fail; for a failure recorded before the column existed, the logs endpoint derives one from the build log’s summary block.

object

class

Class is one of the FailureClass* values.

string

first_error_line

FirstErrorLine is the first line of the build’s own output that reads as the cause, not the exit-code line that follows it. Empty when there is no such line.

string

fix

Fix is the settings change that would clear this failure, when we know one.

object

branch

string

build_command

string

output_dir

string

package_manager

string

root_directory

string

reason

Reason is the one-sentence classified error, the same line the log’s summary block holds.

string

stage

Stage is where the build stopped: Configuration, Clone, Build, Upload, Initialization.

string

suggestion

Suggestion is what to do about it, in a sentence or two.

string

was

Was holds the values the failed build ran with, for the fields Fix changes.

object

branch

string

build_command

string

output_dir

string

package_manager

string

root_directory

string

file_count

integer

framework

Framework the project was built as, e.g. “astro”. “unknown” when unresolved.

string

has_custom_404

boolean

has_spa_fallback

boolean

header_rules

Array<object>

object

for

string

values

object

key

additional properties

string

id

string

is_preview

boolean

package_manager

PackageManager used for this build: npm, pnpm, yarn or bun.

string

preview_url

string

project_id

string

queue

Queue is set only while Status is queued: where this deployment sits in the build queue (DEP-326). Never stored.

object

aging_minutes

integer

ahead

integer

behind_standard

integer

estimated_start_seconds

integer

lane

string

slots

integer

redirect_rules

Array<object>

object

force

boolean

from

string

status

integer

to

string

source

Source is where this deployment’s files came from: git or upload.

string

Allowed values: git upload

status

string

Allowed values: pending queued building deployed failed cancelled

team_id

string

total_bytes

integer

trigger_client

string

Allowed values: dashboard cli mcp migrate

trigger_source

Provenance (DEP-674, migration 000113): how the request that created this deployment was authenticated (proven) and which of our clients says it sent it (claimed, from X-Deploybase-Client). Written once by Create and never by Update. nil = unknown: a deployment from before 000113, a client that sent no or an unknown header, or a webhook push, which has no client.

string

Allowed values: session push api_key

updated_at

string

upload_label

UploadLabel is the user-supplied name for an upload, standing in for the commit message a git deployment carries.

string

url

string

warnings

Warnings are user-facing notes about what this deploy published (DEP-442). Written once, with the terminal status, in the same UPDATE. Each stores a code; the wording and the remedy are rendered from it at read time — see deployment_warning.go.

Array<object>

object

code

string

Allowed values: OUTPUT_DIR_IS_REPO_ROOT ARTIFACTS_WITHHELD LINKS_WITHHELD COMMITTED_CREDENTIALS BUILD_NEAR_TIME_LIMIT

duration_seconds

The build timing, set only on BUILD_NEAR_TIME_LIMIT. SlowestStage is empty when the log held no finished stage.

integer

limit_minutes

integer

paths

Paths are the entries the warning is about, relative to the output directory. Empty for warnings that are about configuration rather than files.

Array<string>

slowest_stage

string

slowest_stage_seconds

integer

page

integer

page_size

integer

total

integer

total_pages

integer

Example

{
  "data": {
    "deployments": [
      {
        "source": "git",
        "status": "pending",
        "trigger_client": "dashboard",
        "trigger_source": "session",
        "warnings": [
          {
            "code": "OUTPUT_DIR_IS_REPO_ROOT"
          }
        ]
      }
    ]
  }
}

400

Bad Request

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}