--- title: Get a Workers build --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Workers Builds](https://developers.cloudflare.com/api/resources/workers_builds) [Builds](https://developers.cloudflare.com/api/resources/workers_builds/subresources/builds) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get a Workers build GET/accounts/{account\_id}/builds/builds/{build\_uuid} Retrieve status, outcome, timestamps, trigger settings, and source metadata for a build UUID. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Workers CI Write``Workers CI Read` ##### P ath ParametersExpand Collapse account\_id: string Account identifier. [Link to this property](<#(resource)%20workers_builds.builds%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) build\_uuid: string Build UUID. formatuuid [Link to this property](<#(resource)%20workers_builds.builds%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20build_uuid%20%3E%20(schema)>) ##### ReturnsExpand Collapse
errors: array of object {message, code } message: string Link to this property code: optional number Link to this property
[Link to this property](<#(resource)%20workers_builds.builds%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>) messages: array of string [Link to this property](<#(resource)%20workers_builds.builds%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: 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" Link to this property "fail" Link to this property "skipped" Link to this property "cancelled" Link to this property "terminated" Link to this property
Link to this property
build\_trigger\_metadata: optional object {author, branch, build\_command, 11 more } author: optional string Link to this property branch: optional string Git branch name. Link to this property build\_command: optional string Command to build the Worker. Link to this property build\_token\_name: optional string Link to this property build\_token\_uuid: optional string UUID of the build token used when deploying the Worker. formatuuid Link to this property
build\_trigger\_source: optional "push"or "pull\_request"or "manual"or "api" One of the following: "push" Link to this property "pull\_request" Link to this property "manual" Link to this property "api" Link to this property
Link to this property commit\_hash: optional string Git commit hash Link to this property commit\_message: optional string Link to this property deploy\_command: optional string Command to deploy the Worker. Link to this property environment\_variables: optional map\[string] Link to this property provider\_account\_name: optional string Human-readable name of the account or namespace that owns the repository. Link to this property
provider\_type: optional "github"or "gitlab"or "gitlab\_internal"or "origin" Source control provider. One of the following: "github" Link to this property "gitlab" Link to this property "gitlab\_internal" Link to this property "origin" Link to this property
Link to this property repo\_name: optional string Human-readable repository name. Link to this property root\_directory: optional string Repository directory in which build and deploy commands run. Link to this property
Link to this property build\_uuid: optional string Build UUID. formatuuid Link to this property created\_on: optional string formatdate-time Link to this property
deploy\_hook: optional object {deploy\_hook\_name } deploy\_hook\_name: optional string Deploy hook name (1-58 characters). maxLength58 minLength1 Link to this property
Link to this property initializing\_on: optional string formatdate-time Link to this property modified\_on: optional string formatdate-time Link to this property 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 Link to this property
pull\_request: optional object {closed\_on, created\_on, pull\_request\_url } closed\_on: optional string formatdate-time Link to this property created\_on: optional string formatdate-time Link to this property pull\_request\_url: optional string formaturi Link to this property
Link to this property running\_on: optional string formatdate-time Link to this property
status: optional "queued"or "initializing"or "running"or "stopped" One of the following: "queued" Link to this property "initializing" Link to this property "running" Link to this property "stopped" Link to this property
Link to this property stopped\_on: optional string formatdate-time Link to this property
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. Link to this property branch\_includes: optional array of string Branch patterns that can start builds. Link to this property build\_caching\_enabled: optional boolean Whether builds reuse cached dependencies and build artifacts. Link to this property build\_command: optional string Command to build the Worker. Link to this property created\_on: optional string formatdate-time Link to this property deleted\_on: optional string formatdate-time Link to this property deploy\_command: optional string Command to deploy the Worker. Link to this property external\_script\_id: optional string System-generated tag of the Worker. This is not the Worker name. Link to this property modified\_on: optional string formatdate-time Link to this property path\_excludes: optional array of string Path patterns that must not start builds. Link to this property path\_includes: optional array of string Path patterns that can start builds. Link to this property
repo\_connection: optional object {created\_on, deleted\_on, modified\_on, 6 more } created\_on: optional string formatdate-time Link to this property deleted\_on: optional string formatdate-time Link to this property modified\_on: optional string formatdate-time Link to this property provider\_account\_id: optional string Provider-specific identifier of the account or namespace that owns the repository. Link to this property provider\_account\_name: optional string Human-readable name of the account or namespace that owns the repository. Link to this property
provider\_type: optional "github"or "gitlab"or "gitlab\_internal"or "origin" Source control provider. One of the following: "github" Link to this property "gitlab" Link to this property "gitlab\_internal" Link to this property "origin" Link to this property
Link to this property repo\_connection\_uuid: optional string Repository connection UUID. formatuuid Link to this property repo\_id: optional string Provider-specific repository identifier. Link to this property repo\_name: optional string Human-readable repository name. Link to this property
Link to this property root\_directory: optional string Repository directory in which build and deploy commands run. Link to this property trigger\_name: optional string Human-readable name of the build trigger. Link to this property trigger\_uuid: optional string Trigger UUID. formatuuid Link to this property
Link to this property
[Link to this property](<#(resource)%20workers_builds.builds%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: boolean [Link to this property](<#(resource)%20workers_builds.builds%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result\_info: optional object {count, page, per\_page, 2 more } count: optional number Link to this property page: optional number Link to this property per\_page: optional number Link to this property total\_count: optional number Link to this property total\_pages: optional number Link to this property
[Link to this property](<#(resource)%20workers_builds.builds%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>) ### Get a Workers build HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/builds/builds/$BUILD_UUID \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example 401 example 404 example ``` { "errors": [ { "message": "Not found", "code": 12000 } ], "messages": [ "string" ], "result": { "build_outcome": "success", "build_trigger_metadata": { "author": "developer@cloudflare.com", "branch": "main", "build_command": "npm run build", "build_token_name": "My Build Token", "build_token_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "build_trigger_source": "push", "commit_hash": "abc123def456", "commit_message": "Add new feature", "deploy_command": "npx wrangler deploy", "environment_variables": { "foo": "string" }, "provider_account_name": "Cloudflare", "provider_type": "github", "repo_name": "workers-sdk", "root_directory": "/" }, "build_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_on": "2019-12-27T18:11:19.117Z", "deploy_hook": { "deploy_hook_name": "Production Deploy Hook" }, "initializing_on": "2019-12-27T18:11:19.117Z", "modified_on": "2019-12-27T18:11:19.117Z", "preview_url": "https://abc123-my-worker.my-subdomain.workers.dev", "pull_request": { "closed_on": "2019-12-27T18:11:19.117Z", "created_on": "2019-12-27T18:11:19.117Z", "pull_request_url": "https://github.com/cloudflare/workers-sdk/pull/123" }, "running_on": "2019-12-27T18:11:19.117Z", "status": "running", "stopped_on": "2019-12-27T18:11:19.117Z", "trigger": { "branch_excludes": [ "string" ], "branch_includes": [ "main" ], "build_caching_enabled": false, "build_command": "npm run build", "created_on": "2019-12-27T18:11:19.117Z", "deleted_on": "2019-12-27T18:11:19.117Z", "deploy_command": "npx wrangler deploy", "external_script_id": "dd7160bb9cef458093557736f4b9e75b", "modified_on": "2019-12-27T18:11:19.117Z", "path_excludes": [ "*.md" ], "path_includes": [ "*" ], "repo_connection": { "created_on": "2019-12-27T18:11:19.117Z", "deleted_on": "2019-12-27T18:11:19.117Z", "modified_on": "2019-12-27T18:11:19.117Z", "provider_account_id": "cloudflare", "provider_account_name": "Cloudflare", "provider_type": "github", "repo_connection_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "repo_id": "workers-sdk", "repo_name": "workers-sdk" }, "root_directory": "/", "trigger_name": "Production Deploy", "trigger_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } }, "success": true, "result_info": { "count": 25, "page": 1, "per_page": 50, "total_count": 150, "total_pages": 3 } } ``` ``` { "errors": [ { "code": 12005, "message": "Missing token from authorization header" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 12000, "message": "Not found" } ], "messages": [], "result": null, "success": false } ``` ##### Returns Examples 200 example 401 example 404 example ``` { "errors": [ { "message": "Not found", "code": 12000 } ], "messages": [ "string" ], "result": { "build_outcome": "success", "build_trigger_metadata": { "author": "developer@cloudflare.com", "branch": "main", "build_command": "npm run build", "build_token_name": "My Build Token", "build_token_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "build_trigger_source": "push", "commit_hash": "abc123def456", "commit_message": "Add new feature", "deploy_command": "npx wrangler deploy", "environment_variables": { "foo": "string" }, "provider_account_name": "Cloudflare", "provider_type": "github", "repo_name": "workers-sdk", "root_directory": "/" }, "build_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "created_on": "2019-12-27T18:11:19.117Z", "deploy_hook": { "deploy_hook_name": "Production Deploy Hook" }, "initializing_on": "2019-12-27T18:11:19.117Z", "modified_on": "2019-12-27T18:11:19.117Z", "preview_url": "https://abc123-my-worker.my-subdomain.workers.dev", "pull_request": { "closed_on": "2019-12-27T18:11:19.117Z", "created_on": "2019-12-27T18:11:19.117Z", "pull_request_url": "https://github.com/cloudflare/workers-sdk/pull/123" }, "running_on": "2019-12-27T18:11:19.117Z", "status": "running", "stopped_on": "2019-12-27T18:11:19.117Z", "trigger": { "branch_excludes": [ "string" ], "branch_includes": [ "main" ], "build_caching_enabled": false, "build_command": "npm run build", "created_on": "2019-12-27T18:11:19.117Z", "deleted_on": "2019-12-27T18:11:19.117Z", "deploy_command": "npx wrangler deploy", "external_script_id": "dd7160bb9cef458093557736f4b9e75b", "modified_on": "2019-12-27T18:11:19.117Z", "path_excludes": [ "*.md" ], "path_includes": [ "*" ], "repo_connection": { "created_on": "2019-12-27T18:11:19.117Z", "deleted_on": "2019-12-27T18:11:19.117Z", "modified_on": "2019-12-27T18:11:19.117Z", "provider_account_id": "cloudflare", "provider_account_name": "Cloudflare", "provider_type": "github", "repo_connection_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "repo_id": "workers-sdk", "repo_name": "workers-sdk" }, "root_directory": "/", "trigger_name": "Production Deploy", "trigger_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" } }, "success": true, "result_info": { "count": 25, "page": 1, "per_page": 50, "total_count": 150, "total_pages": 3 } } ``` ``` { "errors": [ { "code": 12005, "message": "Missing token from authorization header" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 12000, "message": "Not found" } ], "messages": [], "result": null, "success": false } ```