Skip to content
Start here

Workers Builds

Get latest builds by script IDs
GET/accounts/{account_id}/builds/builds/latest
Get builds by Worker version
GET/accounts/{account_id}/builds/builds
Get build-minute availability
GET/accounts/{account_id}/builds/account/limits
ModelsExpand Collapse
WorkersBuildGetLatestBuildsResponse = object { builds } or object { builds }
One of the following:
Builds object { builds }
builds: optional map[object { build_outcome, build_trigger_metadata, build_uuid, 10 more } ]
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
Builds object { builds }
builds: optional map[object { build_outcome, build_trigger_metadata, build_uuid, 10 more } ]
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
WorkersBuildGetBuildsByVersionResponse = object { builds } or object { builds }
One of the following:
Builds object { builds }
builds: optional map[object { build_outcome, build_trigger_metadata, build_uuid, 10 more } ]
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
Builds object { builds }
builds: optional map[object { build_outcome, build_trigger_metadata, build_uuid, 10 more } ]
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
WorkersBuildGetAccountLimitsResponse = object { build_minutes_refresh_on, has_reached_build_minutes_limit } or object { build_minutes_refresh_on, has_reached_build_minutes_limit }
One of the following:
object { build_minutes_refresh_on, has_reached_build_minutes_limit }
build_minutes_refresh_on: optional string

When build minutes will refresh (only for non-paid plans)

formatdate-time
has_reached_build_minutes_limit: optional boolean

Whether build minutes limit has been reached (only for non-paid plans)

object { build_minutes_refresh_on, has_reached_build_minutes_limit }
build_minutes_refresh_on: optional string

When build minutes will refresh (only for non-paid plans)

formatdate-time
has_reached_build_minutes_limit: optional boolean

Whether build minutes limit has been reached (only for non-paid plans)

Workers BuildsTriggers

List triggers for a Worker
GET/accounts/{account_id}/builds/workers/{external_script_id}/triggers
Create a build trigger
POST/accounts/{account_id}/builds/triggers
Update a build trigger
PATCH/accounts/{account_id}/builds/triggers/{trigger_uuid}
Delete a build trigger
DELETE/accounts/{account_id}/builds/triggers/{trigger_uuid}
Purge a trigger's build cache
POST/accounts/{account_id}/builds/triggers/{trigger_uuid}/purge_build_cache
Start a Workers build
POST/accounts/{account_id}/builds/triggers/{trigger_uuid}/builds
ModelsExpand Collapse
TriggerListResponse = unknown or array of unknown
One of the following:
unknown
array of unknown
TriggerCreateResponse = object { branch_excludes, branch_includes, build_caching_enabled, 14 more } or object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
One of the following:
object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
TriggerUpdateResponse = object { branch_excludes, branch_includes, build_caching_enabled, 14 more } or object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
One of the following:
object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
TriggerDeleteResponse = unknown or array of unknown
One of the following:
unknown
array of unknown
TriggerPurgeCacheResponse = unknown or array of unknown
One of the following:
unknown
array of unknown
TriggerCreateBuildResponse = object { build_outcome, build_trigger_metadata, build_uuid, 10 more } or object { build_outcome, build_trigger_metadata, build_uuid, 10 more }
One of the following:
object { build_outcome, build_trigger_metadata, build_uuid, 10 more }
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
object { build_outcome, build_trigger_metadata, build_uuid, 10 more }
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid

Workers BuildsTriggersEnvironment Variables

List build variables
GET/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables
Set build variables
PATCH/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables
Delete a build variable
DELETE/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables/{environment_variable_key}
ModelsExpand Collapse
EnvironmentVariableListResponse = unknown or unknown
One of the following:
unknown
unknown
EnvironmentVariableUpsertResponse = unknown or unknown
One of the following:
unknown
unknown
EnvironmentVariableDeleteResponse = unknown or array of unknown
One of the following:
unknown
array of unknown

Workers BuildsDeploy Hooks

List deploy hooks
GET/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks
Create a deploy hook
POST/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks
Get a deploy hook
GET/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}
Update a deploy hook
PUT/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}
Delete a deploy hook
DELETE/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}
Trigger deploy hook
POST/workers/builds/deploy_hooks/{deploy_hook_uuid}
ModelsExpand Collapse
DeployHookListResponse = unknown or array of unknown
One of the following:
unknown
array of unknown
DeployHookCreateResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }
One of the following:
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
DeployHookGetResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }
One of the following:
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
DeployHookUpdateResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }
One of the following:
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
DeployHookDeleteResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }
One of the following:
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
object { branch, created_on, deploy_hook_name, 3 more }
branch: optional string

Git branch name.

created_on: optional string
formatdate-time
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid
external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
DeployHookTriggerResponse = object { already_exists, build_uuid, created_on, status } or object { already_exists, build_uuid, created_on, status }
One of the following:
object { already_exists, build_uuid, created_on, status }
already_exists: optional boolean

True if a pending build already exists for this branch

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
object { already_exists, build_uuid, created_on, status }
already_exists: optional boolean

True if a pending build already exists for this branch

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"

Workers BuildsTokens

Create build token
POST/accounts/{account_id}/builds/tokens
List build tokens
GET/accounts/{account_id}/builds/tokens
Delete a build token
DELETE/accounts/{account_id}/builds/tokens/{build_token_uuid}
ModelsExpand Collapse
TokenCreateResponse = object { build_token_name, build_token_uuid, cloudflare_token_id, owner_type } or object { build_token_name, build_token_uuid, cloudflare_token_id, owner_type }
One of the following:
object { build_token_name, build_token_uuid, cloudflare_token_id, owner_type }
build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
cloudflare_token_id: optional string
owner_type: optional string
object { build_token_name, build_token_uuid, cloudflare_token_id, owner_type }
build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
cloudflare_token_id: optional string
owner_type: optional string
TokenListResponse = unknown or array of unknown
One of the following:
unknown
array of unknown
TokenDeleteResponse = unknown or array of unknown
One of the following:
unknown
array of unknown

Workers BuildsRepos

Workers BuildsReposConnections

Create or update a repository connection
PUT/accounts/{account_id}/builds/repos/connections
Delete a repository connection
DELETE/accounts/{account_id}/builds/repos/connections/{repo_connection_uuid}
ModelsExpand Collapse
ConnectionUpsertResponse = object { created_on, deleted_on, modified_on, 6 more } or object { created_on, deleted_on, modified_on, 6 more }
One of the following:
object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

ConnectionDeleteResponse = unknown or array of unknown
One of the following:
unknown
array of unknown

Workers BuildsReposConfig Autofill

Get repository configuration autofill
GET/accounts/{account_id}/builds/repos/{provider_type}/{provider_account_id}/{repo_id}/config_autofill
ModelsExpand Collapse
ConfigAutofillGetResponse = object { config_file, default_worker_name, env_worker_names, 2 more } or object { config_file, default_worker_name, env_worker_names, 2 more }
One of the following:
object { config_file, default_worker_name, env_worker_names, 2 more }
config_file: optional string
default_worker_name: optional string
env_worker_names: optional map[string]
package_manager: optional "npm" or "yarn" or "pnpm" or 2 more

Package manager inferred from repository lockfiles; defaults to npm when none is detected.

One of the following:
"npm"
"yarn"
"pnpm"
"bun"
"uv"
scripts: optional map[string]
object { config_file, default_worker_name, env_worker_names, 2 more }
config_file: optional string
default_worker_name: optional string
env_worker_names: optional map[string]
package_manager: optional "npm" or "yarn" or "pnpm" or 2 more

Package manager inferred from repository lockfiles; defaults to npm when none is detected.

One of the following:
"npm"
"yarn"
"pnpm"
"bun"
"uv"
scripts: optional map[string]

Workers BuildsBuilds

List builds for a Worker
GET/accounts/{account_id}/builds/workers/{external_script_id}/builds
Get a Workers build
GET/accounts/{account_id}/builds/builds/{build_uuid}
Cancel a Workers build
PUT/accounts/{account_id}/builds/builds/{build_uuid}/cancel
ModelsExpand Collapse
BuildListResponse = unknown or array of unknown
One of the following:
unknown
array of unknown
BuildGetResponse = object { build_outcome, build_trigger_metadata, build_uuid, 10 more } or object { build_outcome, build_trigger_metadata, build_uuid, 10 more }
One of the following:
object { build_outcome, build_trigger_metadata, build_uuid, 10 more }
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
object { build_outcome, build_trigger_metadata, build_uuid, 10 more }
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_trigger_metadata: optional object { author, branch, build_command, 11 more }
author: optional string
branch: optional string

Git branch name.

build_command: optional string

Command to build the Worker.

build_token_name: optional string
build_token_uuid: optional string

UUID of the build token used when deploying the Worker.

formatuuid
build_trigger_source: optional "push" or "pull_request" or "manual" or "api"
One of the following:
"push"
"pull_request"
"manual"
"api"
commit_hash: optional string

Git commit hash

commit_message: optional string
deploy_command: optional string

Command to deploy the Worker.

environment_variables: optional map[string]
provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time
deploy_hook: optional object { deploy_hook_name }
deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58
minLength1
initializing_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
preview_url: optional string

URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact.

formaturi
pull_request: optional object { closed_on, created_on, pull_request_url }
closed_on: optional string
formatdate-time
created_on: optional string
formatdate-time
pull_request_url: optional string
formaturi
running_on: optional string
formatdate-time
status: optional "queued" or "initializing" or "running" or "stopped"
One of the following:
"queued"
"initializing"
"running"
"stopped"
stopped_on: optional string
formatdate-time
trigger: optional object { branch_excludes, branch_includes, build_caching_enabled, 12 more }

Trigger information without build_token_uuid

branch_excludes: optional array of string

Branch patterns that must not start builds.

branch_includes: optional array of string

Branch patterns that can start builds.

build_caching_enabled: optional boolean

Whether builds reuse cached dependencies and build artifacts.

build_command: optional string

Command to build the Worker.

created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string

Command to deploy the Worker.

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string
formatdate-time
path_excludes: optional array of string

Path patterns that must not start builds.

path_includes: optional array of string

Path patterns that can start builds.

repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider-specific identifier of the account or namespace that owns the repository.

provider_account_name: optional string

Human-readable name of the account or namespace that owns the repository.

provider_type: optional "github" or "gitlab" or "gitlab_internal" or "origin"

Source control provider.

One of the following:
"github"
"gitlab"
"gitlab_internal"
"origin"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Provider-specific repository identifier.

repo_name: optional string

Human-readable repository name.

root_directory: optional string

Repository directory in which build and deploy commands run.

trigger_name: optional string

Human-readable name of the build trigger.

trigger_uuid: optional string

Trigger UUID.

formatuuid
BuildCancelResponse = object { build_outcome, build_uuid, stopped_on } or object { build_outcome, build_uuid, stopped_on }
One of the following:
object { build_outcome, build_uuid, stopped_on }
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_uuid: optional string

Build UUID.

formatuuid
stopped_on: optional string
formatdate-time
object { build_outcome, build_uuid, stopped_on }
build_outcome: optional "success" or "fail" or "skipped" or 2 more
One of the following:
"success"
"fail"
"skipped"
"cancelled"
"terminated"
build_uuid: optional string

Build UUID.

formatuuid
stopped_on: optional string
formatdate-time

Workers BuildsBuildsLogs

Get Workers build logs
GET/accounts/{account_id}/builds/builds/{build_uuid}/logs
ModelsExpand Collapse
LogGetResponse = object { cursor, lines, truncated } or object { cursor, lines, truncated }
One of the following:
object { cursor, lines, truncated }
cursor: optional string

Pagination cursor for log retrieval.

lines: optional array of array of number or string
One of the following:
number

Unix epoch timestamp

string

Log message

truncated: optional boolean
object { cursor, lines, truncated }
cursor: optional string

Pagination cursor for log retrieval.

lines: optional array of array of number or string
One of the following:
number

Unix epoch timestamp

string

Log message

truncated: optional boolean