POST /accounts/{account_id}/workers/scripts/{script_name}/deployments
Deployments configure how Worker Versions are deployed to traffic. A deployment can consist of one or two versions of a Worker.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
script_name |
String | Yes | |
account_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
force |
Boolean | No |
If set to true, the deployment will be created even if normally blocked by something such rolling back to an older version when a secret has changed. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No | |
source |
String | No | |
annotations |
Object | No | |
annotations.workers/message |
String | No |
Human-readable message about the deployment. Truncated to 100 bytes. |
strategy |
String | Yes |
Possible values:
|
created_on |
String | No | |
author_email |
String | No | |
versions[] |
Array | Yes | |
versions[].percentage |
Number | Yes | |
versions[].version_id |
String | Yes |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.