--- title: Instances --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Workflows](https://developers.cloudflare.com/api/python/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/python/resources/workflows/subresources/instances/methods/list) workflows.instances.list(strworkflow\_name, InstanceListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[InstanceListResponse]()] GET/accounts/{account\_id}/workflows/{workflow\_name}/instances ##### [Get logs and status from instance](https://developers.cloudflare.com/api/python/resources/workflows/subresources/instances/methods/get) workflows.instances.get(strinstance\_id, InstanceGetParams\*\*kwargs) -> [InstanceGetResponse]() GET/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id} ##### [Create a new workflow instance](https://developers.cloudflare.com/api/python/resources/workflows/subresources/instances/methods/create) workflows.instances.create(strworkflow\_name, InstanceCreateParams\*\*kwargs) -> [InstanceCreateResponse]() POST/accounts/{account\_id}/workflows/{workflow\_name}/instances ##### [Batch create new Workflow instances](https://developers.cloudflare.com/api/python/resources/workflows/subresources/instances/methods/bulk) workflows.instances.bulk(strworkflow\_name, InstanceBulkParams\*\*kwargs) -> SyncSinglePage\[[InstanceBulkResponse]()] POST/accounts/{account\_id}/workflows/{workflow\_name}/instances/batch ##### [Get full step output from instance](https://developers.cloudflare.com/api/python/resources/workflows/subresources/instances/methods/step) workflows.instances.step(strinstance\_id, InstanceStepParams\*\*kwargs) -> [InstanceStepResponse]() GET/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}/step ##### ModelsExpand Collapse
class InstanceListResponse: … id: str maxLength100 minLength1 Link to this property created\_on: datetime formatdate-time Link to this property ended\_on: Optional\[datetime] formatdate-time Link to this property modified\_on: datetime formatdate-time Link to this property started\_on: Optional\[datetime] formatdate-time Link to this property
status: Literal\["queued", "running", "paused", 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: str formatuuid Link to this property workflow\_id: str formatuuid Link to this property
trigger\_source: Optional\[Literal\["unknown", "api", "binding", 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)>)
class InstanceGetResponse: … end: Optional\[datetime] formatdate-time Link to this property
error: Optional\[Error] message: str Link to this property name: str Link to this property
Link to this property
output: Union\[str, float] One of the following: str Link to this property float Link to this property
Link to this property params: object Link to this property queued: datetime formatdate-time Link to this property
rollback: Optional\[Rollback]
error: Optional\[RollbackError] message: str Link to this property name: str Link to this property
Link to this property
outcome: Literal\["complete", "failed"] One of the following: "complete" Link to this property "failed" Link to this property
Link to this property
Link to this property start: Optional\[datetime] formatdate-time Link to this property
status: Literal\["queued", "running", "paused", 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 step\_count: int maximum9007199254740991 minimum-9007199254740991 Link to this property
steps: List\[Step] One of the following:
class StepUnionMember0: …
attempts: List\[StepUnionMember0Attempt] end: Optional\[datetime] formatdate-time Link to this property
error: Optional\[StepUnionMember0AttemptError] message: str Link to this property name: str Link to this property
Link to this property start: datetime formatdate-time Link to this property success: Optional\[bool] Link to this property
Link to this property
config: StepUnionMember0Config
retries: StepUnionMember0ConfigRetries
delay: Union\[str, float] Specifies the delay duration. The value ‘\[dynamic]’ means that a user-supplied function computes the delay. One of the following: str Link to this property float Link to this property
Link to this property limit: float Link to this property
backoff: Optional\[Literal\["constant", "linear", "exponential"]] One of the following: "constant" Link to this property "linear" Link to this property "exponential" Link to this property
Link to this property
Link to this property
timeout: Union\[str, float] Specifies the timeout duration. One of the following: str Link to this property float Link to this property
Link to this property sensitive: Optional\[Literal\["output"]] When set to ‘output’, step output is redacted from log and step output responses. Link to this property
Link to this property end: Optional\[datetime] formatdate-time Link to this property name: str Link to this property output: Optional\[str] Link to this property start: datetime formatdate-time Link to this property success: Optional\[bool] Link to this property
type: Literal\["step", "rollback"] One of the following: "step" Link to this property "rollback" Link to this property
Link to this property
Link to this property
class StepUnionMember1: … end: datetime formatdate-time Link to this property
error: Optional\[StepUnionMember1Error] message: str Link to this property name: str Link to this property
Link to this property finished: bool Link to this property name: str Link to this property start: datetime formatdate-time Link to this property type: Literal\["sleep"] Link to this property
Link to this property
class StepUnionMember2: …
trigger: StepUnionMember2Trigger source: str Link to this property
Link to this property type: Literal\["termination"] Link to this property
Link to this property
class StepUnionMember3: … end: datetime formatdate-time Link to this property
error: Optional\[StepUnionMember3Error] message: str Link to this property name: str Link to this property
Link to this property finished: bool Link to this property name: str Link to this property start: datetime formatdate-time Link to this property type: Literal\["waitForEvent"] Link to this property event\_type: Optional\[str] Link to this property output: Optional\[str] Link to this property
Link to this property
Link to this property success: Optional\[bool] Link to this property
trigger: Trigger
source: Literal\["unknown", "api", "binding", 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 version\_id: str formatuuid Link to this property
schedule: Optional\[Schedule] cron: str Link to this property scheduled\_time: float 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)>)
class InstanceCreateResponse: … id: str maxLength100 minLength1 Link to this property
status: Literal\["queued", "running", "paused", 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: str formatuuid Link to this property workflow\_id: str formatuuid Link to this property
trigger\_source: Optional\[Literal\["unknown", "api", "binding", 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)>)
class InstanceBulkResponse: … id: str maxLength100 minLength1 Link to this property
status: Literal\["queued", "running", "paused", 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: str formatuuid Link to this property workflow\_id: str formatuuid Link to this property
trigger\_source: Optional\[Literal\["unknown", "api", "binding", 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)>)
class InstanceStepResponse: …
error: Optional\[Error] Error details when status=‘errored’; null otherwise. message: str Link to this property name: str Link to this property
Link to this property
status: Literal\["queued", "running", "paused", 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 event\_type: Optional\[str] The event type the step is waiting on, as supplied to step.waitForEvent. Only present when type=‘waitForEvent’. Link to this property output: Optional\[object] 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/python/resources/workflows/subresources/instances/subresources/status/methods/edit) workflows.instances.status.edit(strinstance\_id, StatusEditParams\*\*kwargs) -> [StatusEditResponse]() PATCH/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}/status ##### ModelsExpand Collapse
class StatusEditResponse: …
status: Literal\["queued", "running", "paused", 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 timestamp: datetime 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/python/resources/workflows/subresources/instances/subresources/events/methods/create) workflows.instances.events.create(strevent\_type, EventCreateParams\*\*kwargs) -> [EventCreateResponse]() POST/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}/events/{event\_type} ##### ModelsExpand Collapse
class EventCreateResponse: … instance\_id: str Link to this property timestamp: datetime 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)>)