Create deploy hook

POST/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks

Create a new deploy hook for a worker script.

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

Path ParametersExpand Collapse

account_id: string

Account identifier.

script_name: string

Human-readable name of the worker.

Body ParametersJSONExpand Collapse

branch: string

Git branch name.

deploy_hook_name: string

Deploy hook name (1-58 characters).

maxLength58

minLength1

ReturnsExpand Collapse

errors: array of object { code, message }

code: optional number

message: optional string

messages: array of string

result: 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 worker script tag.

modified_on: optional string

formatdate-time

success: boolean

result_info: optional object { count, page, per_page, 2 more }

count: optional number

page: optional number

per_page: optional number

total_count: optional number

total_pages: optional number

Create deploy hook

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/builds/workers/$SCRIPT_NAME/deploy_hooks \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "branch": "main",
          "deploy_hook_name": "Production Deploy Hook"
        }'

{
  "errors": [
    {
      "code": 12000,
      "message": "Not found"
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "branch": "main",
    "created_on": "2019-12-27T18:11:19.117Z",
    "deploy_hook_name": "Production Deploy Hook",
    "deploy_hook_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "external_script_id": "dd7160bb9cef458093557736f4b9e75b",
    "modified_on": "2019-12-27T18:11:19.117Z"
  },
  "success": true,
  "result_info": {
    "count": 25,
    "page": 1,
    "per_page": 50,
    "total_count": 150,
    "total_pages": 3
  }
}

{
  "errors": [
    {
      "code": 12002,
      "message": "Invalid request body"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 12000,
      "message": "Not found"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 12049,
      "message": "Resource already exists"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

Returns Examples

{
  "errors": [
    {
      "code": 12000,
      "message": "Not found"
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "branch": "main",
    "created_on": "2019-12-27T18:11:19.117Z",
    "deploy_hook_name": "Production Deploy Hook",
    "deploy_hook_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "external_script_id": "dd7160bb9cef458093557736f4b9e75b",
    "modified_on": "2019-12-27T18:11:19.117Z"
  },
  "success": true,
  "result_info": {
    "count": 25,
    "page": 1,
    "per_page": 50,
    "total_count": 150,
    "total_pages": 3
  }
}

{
  "errors": [
    {
      "code": 12002,
      "message": "Invalid request body"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 12000,
      "message": "Not found"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 12049,
      "message": "Resource already exists"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}