--- title: Create a new workflow instance --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Workflows](https://developers.cloudflare.com/api/go/resources/workflows) [Instances](https://developers.cloudflare.com/api/go/resources/workflows/subresources/instances) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a new workflow instance client.Workflows.Instances.New(ctx, workflowName, params) (\*[InstanceNewResponse](), error) POST/accounts/{account\_id}/workflows/{workflow\_name}/instances Creates a new instance of a workflow, starting its execution. ##### 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 Scripts Write` ##### ParametersExpand Collapse workflowName string maxLength64 minLength1 [Link to this property](<#(resource)%20workflows.instances%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20workflow_name%20%3E%20(schema)>)
params InstanceNewParams AccountID param.Field\[string] Path param Link to this property InstanceID param.Field\[string]Optional Body param: The system reserves IDs that consist of the cf_ prefix and exactly 64 lowercase hexadecimal characters. maximum100 minimum1 Link to this property
InstanceRetention param.Field\[InstanceNewParamsInstanceRetention]Optional Body param
ErrorRetention InstanceNewParamsInstanceRetentionErrorRetentionUnionOptional Specifies the duration in milliseconds or as a string like ‘5 minutes’. One of the following: UnionInt Link to this property UnionString Link to this property
Link to this property
SuccessRetention InstanceNewParamsInstanceRetentionSuccessRetentionUnionOptional Specifies the duration in milliseconds or as a string like ‘5 minutes’. One of the following: UnionInt Link to this property UnionString Link to this property
Link to this property
Link to this property
LocationHint param.Field\[InstanceNewParamsLocationHint]Optional Body param const InstanceNewParamsLocationHintWnam InstanceNewParamsLocationHint = "wnam" Link to this property const InstanceNewParamsLocationHintWeur InstanceNewParamsLocationHint = "weur" Link to this property const InstanceNewParamsLocationHintEnam InstanceNewParamsLocationHint = "enam" Link to this property const InstanceNewParamsLocationHintEeur InstanceNewParamsLocationHint = "eeur" Link to this property const InstanceNewParamsLocationHintApac InstanceNewParamsLocationHint = "apac" Link to this property const InstanceNewParamsLocationHintApacNe InstanceNewParamsLocationHint = "apac-ne" Link to this property const InstanceNewParamsLocationHintApacSe InstanceNewParamsLocationHint = "apac-se" Link to this property const InstanceNewParamsLocationHintOc InstanceNewParamsLocationHint = "oc" Link to this property const InstanceNewParamsLocationHintSam InstanceNewParamsLocationHint = "sam" Link to this property const InstanceNewParamsLocationHintAfr InstanceNewParamsLocationHint = "afr" Link to this property const InstanceNewParamsLocationHintMe InstanceNewParamsLocationHint = "me" Link to this property
Link to this property Params param.Field\[string]Optional Body param: JSON-encoded event payload passed into the new instance. Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type InstanceNewResponse struct{…} ID string maxLength100 minLength1 Link to this property
Status InstanceNewResponseStatus One of the following: const InstanceNewResponseStatusQueued InstanceNewResponseStatus = "queued" Link to this property const InstanceNewResponseStatusRunning InstanceNewResponseStatus = "running" Link to this property const InstanceNewResponseStatusPaused InstanceNewResponseStatus = "paused" Link to this property const InstanceNewResponseStatusErrored InstanceNewResponseStatus = "errored" Link to this property const InstanceNewResponseStatusTerminated InstanceNewResponseStatus = "terminated" Link to this property const InstanceNewResponseStatusComplete InstanceNewResponseStatus = "complete" Link to this property const InstanceNewResponseStatusWaitingForPause InstanceNewResponseStatus = "waitingForPause" Link to this property const InstanceNewResponseStatusWaiting InstanceNewResponseStatus = "waiting" Link to this property const InstanceNewResponseStatusRollingBack InstanceNewResponseStatus = "rollingBack" Link to this property
Link to this property VersionID string formatuuid Link to this property WorkflowID string formatuuid Link to this property
TriggerSource InstanceNewResponseTriggerSourceOptional One of the following: const InstanceNewResponseTriggerSourceUnknown InstanceNewResponseTriggerSource = "unknown" Link to this property const InstanceNewResponseTriggerSourceAPI InstanceNewResponseTriggerSource = "api" Link to this property const InstanceNewResponseTriggerSourceBinding InstanceNewResponseTriggerSource = "binding" Link to this property const InstanceNewResponseTriggerSourceEvent InstanceNewResponseTriggerSource = "event" Link to this property const InstanceNewResponseTriggerSourceCron InstanceNewResponseTriggerSource = "cron" Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20InstanceNewResponse%20%3E%20(schema)>) ### Create a new workflow instance Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/workflows" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) instance, err := client.Workflows.Instances.New( context.TODO(), "x", workflows.InstanceNewParams{ AccountID: cloudflare.F("account_id"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", instance.ID) } ``` 200 example ``` { "errors": [], "messages": [ { "code": 0, "message": "message" } ], "result": { "id": "x", "status": "queued", "version_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "trigger_source": "unknown" }, "success": true, "result_info": { "count": 0, "per_page": 0, "total_count": 0, "cursor": "cursor", "page": 0, "total_pages": 0 } } ``` ##### Returns Examples 200 example ``` { "errors": [], "messages": [ { "code": 0, "message": "message" } ], "result": { "id": "x", "status": "queued", "version_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "trigger_source": "unknown" }, "success": true, "result_info": { "count": 0, "per_page": 0, "total_count": 0, "cursor": "cursor", "page": 0, "total_pages": 0 } } ```