--- title: Instances --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Workflows](https://developers.cloudflare.com/api/resources/workflows) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Instances ##### [List of workflow instances](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/list) GET/accounts/{account\_id}/workflows/{workflow\_name}/instances ##### [Get logs and status from instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/get) GET/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id} ##### [Create a new workflow instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/create) POST/accounts/{account\_id}/workflows/{workflow\_name}/instances ##### [Batch create new Workflow instances](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/bulk) POST/accounts/{account\_id}/workflows/{workflow\_name}/instances/batch ##### [Get full step output from instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/step) GET/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}/step ##### ModelsExpand Collapse

InstanceListResponse object {id, created\_on, ended\_on, 6 more }

id: string maxLength100 minLength1 Link to this property created\_on: string formatdate-time Link to this property ended\_on: string formatdate-time Link to this property modified\_on: string formatdate-time Link to this property started\_on: string formatdate-time Link to this property

status: "queued"or "running"or "paused"or 6 more

One of the following: "queued" Link to this property "running" Link to this property "paused" Link to this property "errored" Link to this property "terminated" Link to this property "complete" Link to this property "waitingForPause" Link to this property "waiting" Link to this property "rollingBack" Link to this property

Link to this property version\_id: string formatuuid Link to this property workflow\_id: string formatuuid Link to this property

trigger\_source: optional "unknown"or "api"or "binding"or 2 more

One of the following: "unknown" Link to this property "api" Link to this property "binding" Link to this property "event" Link to this property "cron" Link to this property

Link to this property

[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_list_response%20%3E%20(schema)>)

InstanceGetResponse object {end, error, output, 11 more }

end: string formatdate-time Link to this property

error: object {message, name }

message: string Link to this property name: string Link to this property

Link to this property

output: stringor number

One of the following: string Link to this property number Link to this property

Link to this property params: unknown Link to this property queued: string formatdate-time Link to this property

rollback: object {error, outcome }

error: object {message, name }

message: string Link to this property name: string Link to this property

Link to this property

outcome: "complete"or "failed"

One of the following: "complete" Link to this property "failed" Link to this property

Link to this property

Link to this property start: string formatdate-time Link to this property

status: "queued"or "running"or "paused"or 6 more

Link to this property step\_count: number maximum9007199254740991 minimum-9007199254740991 Link to this property

steps: array of object {attempts, config, end, 5 more } or object {end, error, finished, 3 more } or object {trigger, type } or object {end, error, finished, 5 more }

One of the following:

object {attempts, config, end, 5 more }

attempts: array of object {end, error, start, success }

end: string formatdate-time Link to this property

error: object {message, name }

message: string Link to this property name: string Link to this property

Link to this property start: string formatdate-time Link to this property success: boolean Link to this property

Link to this property

config: object {retries, timeout, sensitive }

retries: object {delay, limit, backoff }

delay: stringor number Specifies the delay duration. The value ‘\[dynamic]’ means that a user-supplied function computes the delay.

One of the following: string Link to this property number Link to this property

Link to this property limit: number Link to this property

backoff: optional "constant"or "linear"or "exponential"

One of the following: "constant" Link to this property "linear" Link to this property "exponential" Link to this property

Link to this property

timeout: stringor number Specifies the timeout duration.

One of the following: string Link to this property number Link to this property

Link to this property sensitive: optional "output" When set to ‘output’, step output is redacted from log and step output responses. Link to this property

Link to this property end: string formatdate-time Link to this property name: string Link to this property output: string Link to this property start: string formatdate-time Link to this property success: boolean Link to this property

type: "step"or "rollback"

One of the following: "step" Link to this property "rollback" Link to this property

Link to this property

object {end, error, finished, 3 more }

end: string formatdate-time Link to this property

error: object {message, name }

message: string Link to this property name: string Link to this property

Link to this property finished: boolean Link to this property name: string Link to this property start: string formatdate-time Link to this property type: "sleep" Link to this property

Link to this property

object {trigger, type }

trigger: object {source }

source: string Link to this property

Link to this property type: "termination" Link to this property

Link to this property

object {end, error, finished, 5 more }

end: string formatdate-time Link to this property

error: object {message, name }

message: string Link to this property name: string Link to this property

Link to this property finished: boolean Link to this property name: string Link to this property start: string formatdate-time Link to this property type: "waitForEvent" Link to this property event\_type: optional string Link to this property output: optional string Link to this property

Link to this property

Link to this property success: boolean Link to this property

trigger: object {source }

source: "unknown"or "api"or "binding"or 2 more

One of the following: "unknown" Link to this property "api" Link to this property "binding" Link to this property "event" Link to this property "cron" Link to this property

Link to this property

Link to this property versionId: string formatuuid Link to this property

schedule: optional object {cron, scheduledTime }

cron: string Link to this property scheduledTime: number Link to this property

Link to this property

[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_get_response%20%3E%20(schema)>)

InstanceCreateResponse object {id, status, version\_id, 2 more }

id: string maxLength100 minLength1 Link to this property

status: "queued"or "running"or "paused"or 6 more

Link to this property version\_id: string formatuuid Link to this property workflow\_id: string formatuuid Link to this property

trigger\_source: optional "unknown"or "api"or "binding"or 2 more

One of the following: "unknown" Link to this property "api" Link to this property "binding" Link to this property "event" Link to this property "cron" Link to this property

Link to this property

[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_create_response%20%3E%20(schema)>)

InstanceBulkResponse object {id, status, version\_id, 2 more }

id: string maxLength100 minLength1 Link to this property

status: "queued"or "running"or "paused"or 6 more

Link to this property version\_id: string formatuuid Link to this property workflow\_id: string formatuuid Link to this property

trigger\_source: optional "unknown"or "api"or "binding"or 2 more

One of the following: "unknown" Link to this property "api" Link to this property "binding" Link to this property "event" Link to this property "cron" Link to this property

Link to this property

[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_bulk_response%20%3E%20(schema)>)

InstanceStepResponse object {error, status, event\_type, output }

error: object {message, name } Error details when status=‘errored’; null otherwise.

message: string Link to this property name: string Link to this property

Link to this property

status: "queued"or "running"or "paused"or 6 more

Link to this property event\_type: optional string The event type the step is waiting on, as supplied to step.waitForEvent. Only present when type=‘waitForEvent’. Link to this property output: optional unknown Contains the full step output or waitForEvent payload without truncation. Uses ‘\[REDACTED]’ for sensitive outputs. Contains a value when status=‘complete’. May contain a ReadableStream when step.do returns one; the response serves stream outputs as application/octet-stream rather than JSON. Link to this property

[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_step_response%20%3E%20(schema)>) #### InstancesStatus ##### [Change status of instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/subresources/status/methods/edit) PATCH/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}/status ##### ModelsExpand Collapse

StatusEditResponse object {status, timestamp }

status: "queued"or "running"or "paused"or 6 more

Link to this property timestamp: string Accepts ISO 8601 with no timezone offsets and in UTC. formatdate-time Link to this property

[Link to this property](<#(resource)%20workflows.instances.status%20%3E%20(model)%20status_edit_response%20%3E%20(schema)>) #### InstancesEvents ##### [Send event to instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/subresources/events/methods/create) POST/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}/events/{event\_type} ##### ModelsExpand Collapse

EventCreateResponse object {instanceId, timestamp }

instanceId: string Link to this property timestamp: string Accepts ISO 8601 with no timezone offsets and in UTC. formatdate-time Link to this property

[Link to this property](<#(resource)%20workflows.instances.events%20%3E%20(model)%20event_create_response%20%3E%20(schema)>)