openapi: 3.2.0 info: description: Welcome to Cloudflare's API documentation site. license: name: BSD-3-Clause url: https://opensource.org/licenses/BSD-3-Clause title: Cloudflare Workflows API version: 4.0.0 servers: - description: Client API url: https://api.cloudflare.com/client/v4 security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] tags: - name: Workflows paths: /accounts/{account_id}/triggers/{script_name}: delete: operationId: wor-delete-script-triggers summary: Delete script triggers description: Deletes all event trigger declarations owned by a Worker script. parameters: - name: script_name in: path required: true schema: type: string maxLength: 255 minLength: 1 - name: account_id in: path required: true schema: type: string responses: '200': description: Number of deleted trigger declarations. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: deleted: type: integer maximum: 9007199254740991 minimum: 0 required: - deleted result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Invalid trigger configuration. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Target workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.triggers x-fern-sdk-method-name: delete get: operationId: wor-get-script-triggers summary: Get script triggers description: Returns the event trigger declarations owned by a Worker script. parameters: - name: script_name in: path required: true schema: type: string maxLength: 255 minLength: 1 - name: account_id in: path required: true schema: type: string responses: '200': description: Script trigger declarations. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: script_name: type: string triggers: type: array items: properties: filter: type: object default: {} additionalProperties: anyOf: - maxLength: 1024 type: string - type: number - type: boolean targets: type: array items: properties: script_name: type: string maxLength: 255 minLength: 1 type: type: string enum: - workflow workflow_name: type: string maxLength: 255 minLength: 1 required: - type - script_name - workflow_name type: object maxItems: 100 minItems: 1 type: type: string minLength: 1 required: - type - targets type: object maxItems: 100 required: - script_name - triggers result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Invalid trigger configuration. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Target workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.triggers x-fern-sdk-method-name: get patch: operationId: wor-add-script-triggers summary: Add script triggers description: Adds event trigger declarations without removing existing declarations owned by the script. parameters: - name: script_name in: path required: true schema: type: string maxLength: 255 minLength: 1 - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: properties: filter: type: object default: {} additionalProperties: anyOf: - maxLength: 1024 type: string - type: number - type: boolean targets: type: array items: properties: script_name: type: string maxLength: 255 minLength: 1 type: type: string enum: - workflow workflow_name: type: string maxLength: 255 minLength: 1 required: - type - script_name - workflow_name type: object maxItems: 100 minItems: 1 type: type: string minLength: 1 required: - type - targets type: object maxItems: 100 responses: '200': description: Effective script trigger declarations. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: script_name: type: string triggers: type: array items: properties: filter: type: object default: {} additionalProperties: anyOf: - maxLength: 1024 type: string - type: number - type: boolean targets: type: array items: properties: script_name: type: string maxLength: 255 minLength: 1 type: type: string enum: - workflow workflow_name: type: string maxLength: 255 minLength: 1 required: - type - script_name - workflow_name type: object maxItems: 100 minItems: 1 type: type: string minLength: 1 required: - type - targets type: object maxItems: 100 required: - script_name - triggers result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Invalid trigger configuration. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Target workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.triggers x-fern-sdk-method-name: add put: operationId: wor-replace-script-triggers summary: Replace script triggers description: Replaces all event trigger declarations owned by a Worker script. parameters: - name: script_name in: path required: true schema: type: string maxLength: 255 minLength: 1 - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: properties: filter: type: object default: {} additionalProperties: anyOf: - maxLength: 1024 type: string - type: number - type: boolean targets: type: array items: properties: script_name: type: string maxLength: 255 minLength: 1 type: type: string enum: - workflow workflow_name: type: string maxLength: 255 minLength: 1 required: - type - script_name - workflow_name type: object maxItems: 100 minItems: 1 type: type: string minLength: 1 required: - type - targets type: object maxItems: 100 responses: '200': description: Effective script trigger declarations. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: script_name: type: string triggers: type: array items: properties: filter: type: object default: {} additionalProperties: anyOf: - maxLength: 1024 type: string - type: number - type: boolean targets: type: array items: properties: script_name: type: string maxLength: 255 minLength: 1 type: type: string enum: - workflow workflow_name: type: string maxLength: 255 minLength: 1 required: - type - script_name - workflow_name type: object maxItems: 100 minItems: 1 type: type: string minLength: 1 required: - type - targets type: object maxItems: 100 required: - script_name - triggers result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Invalid trigger configuration. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Target workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.triggers x-fern-sdk-method-name: replace /accounts/{account_id}/workflows: get: operationId: wor-list-workflows summary: List all Workflows description: Lists all workflows configured for the account. parameters: - name: per_page in: query schema: type: number default: 10 maximum: 100 minimum: 1 - name: page in: query schema: type: number default: 1 minimum: 1 - name: search in: query description: Allows filtering workflows` name. schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string responses: '200': description: List of all Workflows belonging to a account. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: array items: properties: class_name: type: string created_on: type: string format: date-time id: type: string format: uuid instances: type: object additionalProperties: type: number modified_on: type: string format: date-time name: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ schedules: type: array items: properties: cron: type: string next_instance: type: string required: - cron - next_instance type: object script_deleted: description: Whether the bound Worker was deleted, leaving this Workflow inactive. type: boolean script_name: type: string triggered_on: type: - string - 'null' format: date-time required: - name - id - created_on - modified_on - script_name - class_name - triggered_on - instances type: object result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Input Validation Error. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows x-fern-sdk-method-name: list /accounts/{account_id}/workflows/settings: get: operationId: wor-get-workflow-settings summary: Get account settings description: Retrieves account-level Workflows settings, such as the default instance retention. parameters: - name: account_id in: path required: true schema: type: string responses: '200': description: Account settings. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: default_retention: type: object properties: error_retention: description: Default error retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 success_retention: description: Default success retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.settings x-fern-sdk-method-name: get patch: operationId: wor-update-workflow-settings summary: Update account settings description: Updates only the account-level Workflows settings fields present in the request body. parameters: - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: default_retention: description: Default retention applied to instances of this version when they do not set their own retention. type: object properties: error_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string success_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string responses: '200': description: Updated account settings. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: default_retention: type: object properties: error_retention: description: Default error retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 success_retention: description: Default success retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.settings x-fern-sdk-method-name: edit /accounts/{account_id}/workflows/{workflow_name}: delete: operationId: wor-delete-workflow summary: Deletes a Workflow description: Deletes a Workflow. This only deletes the Workflow and does not delete or modify any Worker associated to this Workflow or bounded to it. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string responses: '200': description: Deletes a Workflow. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: status: type: string enum: - ok success: type: - boolean - 'null' required: - success - status result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows x-fern-sdk-method-name: delete x-forge-require-confirmation: This operation permanently deletes the Workflow. get: operationId: wor-get-workflow-details summary: Get Workflow details description: Retrieves configuration and metadata for a specific workflow. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string responses: '200': description: Get Workflow details. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: class_name: type: string created_on: type: string format: date-time id: type: string format: uuid instances: type: object additionalProperties: type: number modified_on: type: string format: date-time name: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ schedules: type: array items: properties: cron: type: string next_instance: type: string required: - cron - next_instance type: object script_deleted: description: Whether the bound Worker was deleted, leaving this Workflow inactive. type: boolean script_name: type: string triggered_on: type: - string - 'null' format: date-time required: - name - id - created_on - modified_on - script_name - class_name - triggered_on - instances result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Workflow has no deployed versions. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows x-fern-sdk-method-name: get put: operationId: wor-create-or-modify-workflow summary: Create/modify Workflow description: Creates a new workflow or updates an existing workflow definition. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: class_name: type: string maxLength: 255 minLength: 1 concurrency: type: object properties: limit: description: Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit. type: integer maximum: 9007199254740991 minimum: 1 default_retention: description: Default retention applied to instances of this version when they do not set their own retention. type: object properties: error_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string success_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string limits: type: object properties: steps: type: integer maximum: 9007199254740991 minimum: 1 schedules: type: array items: properties: cron: type: string maxLength: 256 minLength: 1 required: - cron type: object maxItems: 200 script_name: type: string maxLength: 255 minLength: 1 required: - script_name - class_name responses: '200': description: Create/modify a Workflow based on a deployed script with an existing `WorkflowEntrypoint` class. Must be done after deploying the corresponding script. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: class_name: type: string created_on: type: string format: date-time id: type: string format: uuid is_deleted: type: number modified_on: type: string format: date-time name: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ script_name: type: string terminator_running: type: number triggered_on: type: - string - 'null' format: date-time version_id: type: string format: uuid required: - version_id - name - id - created_on - modified_on - script_name - class_name - triggered_on - is_deleted - terminator_running result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows x-fern-sdk-method-name: update /accounts/{account_id}/workflows/{workflow_name}/instances: get: operationId: wor-list-workflow-instances summary: List of workflow instances description: Lists all instances of a workflow with their execution status. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: page in: query description: 'Deprecated: use `cursor` for pagination instead.' schema: type: number deprecated: true minimum: 1 - name: per_page in: query schema: type: number default: 50 maximum: 100 minimum: 1 - name: cursor in: query description: Opaque token for cursor-based pagination. Mutually exclusive with `page`. schema: type: string - name: direction in: query description: Defines the direction for cursor-based pagination. schema: type: string enum: - asc - desc - name: status in: query schema: type: string enum: - queued - running - paused - errored - terminated - complete - waitingForPause - waiting - rollingBack - name: date_start in: query description: Accepts ISO 8601 with no timezone offsets and in UTC. schema: type: string format: date-time x-fern-parameter-name: start - name: date_end in: query description: Accepts ISO 8601 with no timezone offsets and in UTC. schema: type: string format: date-time x-fern-parameter-name: end - name: account_id in: path required: true schema: type: string responses: '200': description: List of workflow instances. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: array items: properties: created_on: type: string format: date-time ended_on: type: - string - 'null' format: date-time id: type: string maxLength: 100 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ modified_on: type: string format: date-time started_on: type: - string - 'null' format: date-time status: type: string enum: - queued - running - paused - errored - terminated - complete - waitingForPause - waiting - rollingBack trigger_source: type: string enum: - unknown - api - binding - event - cron version_id: type: string format: uuid workflow_id: type: string format: uuid required: - id - created_on - modified_on - started_on - ended_on - workflow_id - version_id - status type: object result_info: type: object properties: count: type: number cursor: type: string page: description: 'Deprecated: use cursor-based pagination instead.' type: number deprecated: true per_page: type: number total_count: description: 'Deprecated: cursor-based pagination can produce an inaccurate total count.' type: number deprecated: true total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Input Validation Error. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow Name not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: list post: operationId: wor-create-new-workflow-instance summary: Create a new workflow instance description: Creates a new instance of a workflow, starting its execution. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: instance_id: description: The system reserves IDs that consist of the `cf_` prefix and exactly 64 lowercase hexadecimal characters. type: string maximum: 100 minimum: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ instance_retention: type: object properties: error_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string x-fern-property-name: error success_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string x-fern-property-name: success location_hint: type: string enum: - wnam - weur - enam - eeur - apac - apac-ne - apac-se - oc - sam - afr - me params: description: JSON-encoded event payload passed into the new instance. type: string responses: '200': description: Create workflow instance. Body is a JSON parsable string that it's passed into the new instance as the event payload. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: id: type: string maxLength: 100 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ status: type: string enum: - queued - running - paused - errored - terminated - complete - waitingForPause - waiting - rollingBack trigger_source: type: string enum: - unknown - api - binding - event - cron version_id: type: string format: uuid workflow_id: type: string format: uuid required: - id - workflow_id - version_id - status result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Provided Workflow ID is not valid. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow Name not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: create x-forge-params: params: fromFile: format: json /accounts/{account_id}/workflows/{workflow_name}/instances/batch: post: operationId: wor-batch-create-workflow-instance summary: Batch create new Workflow instances description: Creates multiple workflow instances in a single batch operation. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: properties: instance_id: description: The system reserves IDs that consist of the `cf_` prefix and exactly 64 lowercase hexadecimal characters. type: string maximum: 100 minimum: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ instance_retention: type: object properties: error_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string x-fern-property-name: error success_retention: description: Specifies the duration in milliseconds or as a string like '5 minutes'. anyOf: - description: Specifies the duration in milliseconds. type: integer - example: 5 minutes pattern: ^(\d+)\s+(second|minute|hour|day|week|month|year)s?$ type: string x-fern-property-name: success location_hint: type: string enum: - wnam - weur - enam - eeur - apac - apac-ne - apac-se - oc - sam - afr - me params: description: JSON-encoded event payload passed into the new instance. type: string type: object maxItems: 100 minItems: 1 responses: '200': description: Batch create workflow instances. Body is a JSON list that contain all payloads and ids that are passed into the new instance as the event payload. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: array items: properties: id: type: string maxLength: 100 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ status: type: string enum: - queued - running - paused - errored - terminated - complete - waitingForPause - waiting - rollingBack trigger_source: type: string enum: - unknown - api - binding - event - cron version_id: type: string format: uuid workflow_id: type: string format: uuid required: - id - workflow_id - version_id - status type: object result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Provided Workflow ID is not valid. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow Name not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances.batch x-fern-sdk-method-name: create /accounts/{account_id}/workflows/{workflow_name}/instances/batch/delete: post: operationId: wor-batch-delete-workflow-instances summary: Batch delete instances of a workflow description: Deletes multiple workflow instances in a single batch operation. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: instances: type: array items: description: Instance identifier. Accepts user-created IDs (`^[a-zA-Z0-9_][a-zA-Z0-9-_]*$`, maximum 100 characters) and system-generated IDs that consist of a `cf_` or `-` prefix and exactly 64 lowercase hexadecimal characters. maxLength: 100 minLength: 1 pattern: ^(-[0-9a-f]{64}|[a-zA-Z0-9_][a-zA-Z0-9-_]*)$ type: string maxItems: 100 minItems: 1 required: - instances responses: '200': description: Returns deleted instances and any per-instance errors. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: deleted: type: array items: properties: id: type: string required: - id type: object errors: type: array items: properties: code: type: number id: type: string message: type: string required: - id - code - message type: object required: - deleted - errors result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Input Validation Error. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow Name not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.instances.batch x-fern-sdk-method-name: delete /accounts/{account_id}/workflows/{workflow_name}/instances/batch/terminate: post: operationId: wor-batch-terminate-workflow-instances summary: Batch terminate instances of a workflow description: Performs a batch termination of multiple workflow instances. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: maxLength: 100 minLength: 1 pattern: ^(-[0-9a-f]{64}|[a-zA-Z0-9_][a-zA-Z0-9-_]*)$ type: string maxItems: 100 minItems: 1 responses: '200': description: Batch terminate instances of a workflow, via a async job. Body is a JSON list that contain the ids of the instances to terminate. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: instancesTerminated: type: number status: type: string enum: - ok - already_running required: - status - instancesTerminated result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Provided Workflow ID is not valid. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow Name not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.instances.batch x-fern-sdk-method-name: terminate /accounts/{account_id}/workflows/{workflow_name}/instances/terminate: get: operationId: wor-status-terminate-workflow-instances summary: Get status of the job responsible for terminate all instances of a workflow description: Gets the status of a bulk workflow instance termination job. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string responses: '200': description: Get status of the job responsible for terminate all instances of a workflow. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: status: type: string enum: - running - not_running required: - status result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Input Validation Error. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow Name not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.instances.batch x-fern-sdk-method-name: termination-status /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}: delete: operationId: wor-delete-workflow-instance summary: Delete a workflow instance description: Deletes a workflow instance and its stored state. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: instance_id in: path description: Instance identifier. User-created instances match `^[a-zA-Z0-9_][a-zA-Z0-9-_]*$` (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. required: true schema: type: string maxLength: 271 minLength: 1 - name: account_id in: path required: true schema: type: string responses: '200': description: Instance deleted. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: instanceId: type: string timestamp: description: Accepts ISO 8601 with no timezone offsets and in UTC. type: string format: date-time required: - instanceId - timestamp result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '404': description: Workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: delete get: operationId: wor-describe-workflow-instance summary: Get logs and status from instance description: Retrieves logs and execution status for a specific workflow instance. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: instance_id in: path description: Instance identifier. User-created instances match `^[a-zA-Z0-9_][a-zA-Z0-9-_]*$` (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. required: true schema: type: string maxLength: 271 minLength: 1 - name: simple in: query description: When true, omits step details and returns only metadata with step_count. schema: type: string default: 'false' enum: - 'true' - 'false' - name: order in: query description: 'Step ordering: "asc" (default, oldest first) or "desc" (newest first).' schema: type: string default: asc enum: - asc - desc - name: account_id in: path required: true schema: type: string responses: '200': description: Get all logs and status from the instance. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: end: type: - string - 'null' format: date-time error: type: - object - 'null' properties: message: type: string name: type: string required: - name - message output: anyOf: - type: string - type: number params: type: object queued: type: string format: date-time rollback: type: - object - 'null' properties: error: type: - object - 'null' properties: message: type: string name: type: string required: - name - message outcome: type: string enum: - complete - failed required: - outcome - error schedule: type: object properties: cron: type: string scheduledTime: type: number required: - cron - scheduledTime start: type: - string - 'null' format: date-time status: type: string enum: - queued - running - paused - errored - terminated - complete - waitingForPause - waiting - rollingBack step_count: type: integer maximum: 9007199254740991 minimum: -9007199254740991 steps: type: array items: anyOf: - properties: attempts: type: array items: properties: end: type: - string - 'null' format: date-time error: type: - object - 'null' properties: message: type: string name: type: string required: - name - message start: type: string format: date-time success: type: - boolean - 'null' required: - start - end - success - error type: object config: type: object properties: retries: type: object properties: backoff: type: string enum: - constant - linear - exponential delay: description: Specifies the delay duration. The value '[dynamic]' means that a user-supplied function computes the delay. anyOf: - type: string - type: number limit: type: number required: - limit - delay sensitive: description: When set to 'output', step output is redacted from log and step output responses. type: string enum: - output timeout: description: Specifies the timeout duration. anyOf: - type: string - type: number required: - retries - timeout end: type: - string - 'null' format: date-time name: type: string output: type: - string - 'null' start: type: string format: date-time success: type: - boolean - 'null' type: type: string enum: - step - rollback required: - name - start - end - attempts - config - output - success - type type: object - properties: end: type: string format: date-time error: type: - object - 'null' properties: message: type: string name: type: string required: - name - message finished: type: boolean name: type: string start: type: string format: date-time type: type: string enum: - sleep required: - name - start - end - finished - type - error type: object - properties: trigger: type: object properties: source: type: string required: - source type: type: string enum: - termination required: - type - trigger type: object - properties: end: type: string format: date-time error: type: - object - 'null' properties: message: type: string name: type: string required: - name - message event_type: type: string finished: type: boolean name: type: string output: type: string start: type: string format: date-time type: type: string enum: - waitForEvent required: - name - start - end - finished - type - error type: object success: type: - boolean - 'null' trigger: type: object properties: source: type: string enum: - unknown - api - binding - event - cron required: - source versionId: type: string format: uuid required: - params - trigger - versionId - queued - start - end - step_count - steps - success - error - status - output - rollback result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Instance not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: get /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}: post: operationId: wor-send-event-workflow-instance summary: Send event to instance description: Sends an event to a running workflow instance to trigger state transitions. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: instance_id in: path description: Instance identifier. User-created instances match `^[a-zA-Z0-9_][a-zA-Z0-9-_]*$` (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. required: true schema: type: string maxLength: 271 minLength: 1 - name: event_type in: path required: true schema: type: string maxLength: 100 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object responses: '200': description: Send an event to an instance. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: instanceId: type: string timestamp: description: Accepts ISO 8601 with no timezone offsets and in UTC. type: string format: date-time required: - instanceId - timestamp result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Workflow not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances.events x-fern-sdk-method-name: send /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status: patch: operationId: wor-change-status-workflow-instance summary: Change status of instance description: Changes the execution status of a workflow instance (e.g., pause, resume, terminate). parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: instance_id in: path description: Instance identifier. User-created instances match `^[a-zA-Z0-9_][a-zA-Z0-9-_]*$` (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. required: true schema: type: string maxLength: 271 minLength: 1 - name: account_id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: oneOf: - properties: status: type: string enum: - pause required: - status type: object - properties: status: type: string enum: - resume required: - status type: object - properties: rollback: description: Run rollback before terminating. type: boolean status: type: string enum: - terminate required: - status type: object - properties: from: description: Step to restart from. type: object properties: count: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 name: type: string maxLength: 256 minLength: 1 type: type: string enum: - do - sleep - waitForEvent required: - name status: type: string enum: - restart required: - status type: object responses: '200': description: Change status of instance - it can be paused, resumed or terminated. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: status: type: string enum: - queued - running - paused - errored - terminated - complete - waitingForPause - waiting - rollingBack timestamp: description: Accepts ISO 8601 with no timezone offsets and in UTC. type: string format: date-time required: - status - timestamp result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Instance not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '409': description: Instance not in a restartable state. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Scripts Write x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-sdk-group-name: workflows.instances.status x-fern-sdk-method-name: edit x-forge-aliases: - x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: pause x-forge-params: from: hidden: true rollback: hidden: true status: default: pause hidden: true - x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: resume x-forge-params: from: hidden: true rollback: hidden: true status: default: resume hidden: true - x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: terminate x-forge-params: from: hidden: true status: default: terminate hidden: true x-forge-require-confirmation: This operation terminates the running Workflow instance. - x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: restart x-forge-params: rollback: hidden: true status: default: restart hidden: true /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/step: get: operationId: wor-get-workflow-instance-step summary: Get full step output from instance description: Retrieves the full, untruncated output for a specific step on a workflow instance. Returns a flat status-shaped JSON body with step `status` ('running' | 'waiting' | 'complete' | 'errored'), `error` (nullable), and `output` (the step value, or null while running/waiting/errored). When the step returned a ReadableStream from step.do, the response is served as 'application/octet-stream' with the raw bytes as the body instead of JSON. A `status='running'` response with non-null `error` indicates the step is currently retrying after a prior attempt failed. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: instance_id in: path description: Instance identifier. User-created instances match `^[a-zA-Z0-9_][a-zA-Z0-9-_]*$` (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. required: true schema: type: string maxLength: 271 minLength: 1 - name: name in: query description: Exact step name from the instance logs response, including the generated counter suffix. required: true schema: type: string minLength: 1 - name: type in: query description: Step type to disambiguate step.do and waitForEvent entries that share the same name. required: true schema: type: string enum: - step - waitForEvent - name: attempt in: query description: Specific attempt number to retrieve output or error for. schema: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 - name: account_id in: path required: true schema: type: string responses: '200': description: Get the full output from a specific instance step. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: error: description: Error details when status='errored'; null otherwise. type: - object - 'null' properties: message: type: string name: type: string required: - name - message event_type: description: The event type the step is waiting on, as supplied to step.waitForEvent. Only present when type='waitForEvent'. type: string output: description: 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. type: object status: type: string enum: - queued - running - paused - errored - terminated - complete - waitingForPause - waiting - rollingBack required: - status - error result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages application/octet-stream: schema: description: Raw bytes of the ReadableStream returned from step.do. type: string format: binary '400': description: Bad Request (e.g. 'attempt' parameter supplied with type='waitForEvent'). content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Step not found on this instance, or requested attempt is out of range. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '429': description: Step output requests are rate limited. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '500': description: Step completed but its stored output is corrupt or missing (server-side data-integrity failure). content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances.step x-fern-sdk-method-name: get /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/subscribe: get: operationId: wor-subscribe-workflow-instance-events summary: Subscribe to workflow instance events description: Opens a WebSocket that streams workflow instance events. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: instance_id in: path description: Instance identifier. User-created instances match `^[a-zA-Z0-9_][a-zA-Z0-9-_]*$` (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. required: true schema: type: string maxLength: 271 minLength: 1 - name: cursor in: query description: Last event ID already received. schema: type: integer - name: filter in: query description: Workflow event types to include. Send multiple event types by repeating the filter query parameter. schema: type: array items: enum: - workflow_queued - workflow_started - workflow_running - workflow_paused - workflow_waiting_for_pause - workflow_waiting - workflow_completed - workflow_errored - workflow_terminated - step_started - step_completed - step_errored - attempt_started - attempt_completed - attempt_errored - sleep_started - sleep_completed - wait_started - wait_completed - wait_timed_out - rollback_started - rollback_step_started - rollback_step_completed - rollback_step_errored - rollback_attempt_started - rollback_attempt_completed - rollback_attempt_errored - rollback_completed - rollback_errored type: string - name: account_id in: path required: true schema: type: string responses: '101': description: WebSocket subscription established. '400': description: Invalid subscription options. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Instance not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: subscribe /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/subscribe/token: get: operationId: wor-create-workflow-instance-subscription-token summary: Create a workflow instance event subscription token description: Creates a short-lived token for connecting to the workflow instance event WebSocket. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: instance_id in: path description: Instance identifier. User-created instances match `^[a-zA-Z0-9_][a-zA-Z0-9-_]*$` (max 100 characters); cron-triggered instances can use a longer, system-generated id derived from the cron expression. required: true schema: type: string maxLength: 271 minLength: 1 - name: account_id in: path required: true schema: type: string responses: '200': description: A five-minute subscription token. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: token: type: string websocketUrl: type: string required: - token - websocketUrl result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Workflow event subscriptions require control plane v2. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Instance not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.instances x-fern-sdk-method-name: subscribe-token /accounts/{account_id}/workflows/{workflow_name}/versions: get: operationId: wor-list-workflow-versions summary: List deployed Workflow versions description: Lists all deployed versions of a workflow. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: per_page in: query schema: type: number default: 50 maximum: 100 minimum: 1 - name: page in: query schema: type: number default: 1 minimum: 1 - name: account_id in: path required: true schema: type: string responses: '200': description: List deployed workflow versions. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: array items: properties: class_name: type: string concurrency: type: object properties: limit: description: Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit. type: integer maximum: 9007199254740991 minimum: 1 created_on: type: string format: date-time default_retention: type: object properties: error_retention: description: Default error retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 success_retention: description: Default success retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 has_dag: type: boolean id: type: string format: uuid language: description: The programming language of the workflow implementation. type: string enum: - javascript - python limits: type: object properties: steps: type: integer maximum: 9007199254740991 minimum: 1 modified_on: type: string format: date-time workflow_id: type: string format: uuid required: - created_on - modified_on - id - workflow_id - class_name - has_dag - language type: object result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.versions x-fern-sdk-method-name: list /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}: get: operationId: wor-describe-workflow-versions summary: Get Workflow version details description: Retrieves details for a specific deployed workflow version. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: version_id in: path required: true schema: type: string format: uuid - name: account_id in: path required: true schema: type: string responses: '200': description: Get specific version details. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: class_name: type: string concurrency: type: object properties: limit: description: Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit. type: integer maximum: 9007199254740991 minimum: 1 created_on: type: string format: date-time default_retention: type: object properties: error_retention: description: Default error retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 success_retention: description: Default success retention in milliseconds. type: integer maximum: 9007199254740991 minimum: -9007199254740991 has_dag: type: boolean id: type: string format: uuid language: description: The programming language of the workflow implementation. type: string enum: - javascript - python limits: type: object properties: steps: type: integer maximum: 9007199254740991 minimum: 1 modified_on: type: string format: date-time workflow_id: type: string format: uuid required: - created_on - modified_on - id - workflow_id - class_name - has_dag - language result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '400': description: Bad Request. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result '404': description: Version not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.versions x-fern-sdk-method-name: get /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/dag: get: operationId: wor-describe-workflow-versions-dag summary: Get Workflow version dag description: Retrieves the directed acyclic graph (DAG) representation of a workflow version. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: version_id in: path required: true schema: type: string format: uuid - name: account_id in: path required: true schema: type: string responses: '200': description: Get the parsed DAG for a specific workflow version. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: class_name: type: string created_on: type: string format: date-time dag: type: - object - 'null' id: type: string format: uuid modified_on: type: string format: date-time workflow_id: type: string format: uuid required: - created_on - modified_on - id - workflow_id - class_name - dag result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '404': description: Version not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-ignore: true x-fern-sdk-group-name: workflows.versions x-fern-sdk-method-name: dag /accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/graph: get: operationId: wor-describe-workflow-versions-graph summary: Get Workflow version graph description: Retrieves the graph visualization of a workflow version. parameters: - name: workflow_name in: path required: true schema: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_][a-zA-Z0-9-_]*$ - name: version_id in: path required: true schema: type: string format: uuid - name: account_id in: path required: true schema: type: string responses: '200': description: Get the parsed graph for a specific workflow version. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object maxItems: 0 messages: type: array items: properties: code: type: number message: type: string required: - code - message type: object result: type: object properties: class_name: type: string created_on: type: string format: date-time graph: description: Versioned workflow graph payload. type: - object - 'null' properties: version: type: number workflow: description: A parsed workflow entrypoint with its step graph. type: object properties: class_name: type: string functions: type: object additionalProperties: properties: name: type: string nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - function_def required: - type - name - nodes type: object nodes: type: array items: oneOf: - properties: duration: description: Duration as milliseconds (number) or human-readable string. anyOf: - type: number - type: string name: type: string resolves: type: number starts: type: number type: type: string enum: - step_sleep required: - type - name - duration type: object - properties: config: description: Configuration for a step (retries and timeout). type: object properties: retries: description: Retry policy for a step. type: object properties: backoff: description: Backoff strategy for step retries. type: string enum: - constant - linear - exponential delay: description: Duration as milliseconds (number) or human-readable string. anyOf: - type: number - type: string limit: type: number required: - limit - delay - backoff timeout: description: Duration as milliseconds (number) or human-readable string. anyOf: - type: number - type: string required: - retries - timeout name: type: string nodes: description: Child nodes (recursive). type: array items: type: object resolves: type: number starts: type: number type: type: string enum: - step_do required: - type - name - config - nodes type: object - properties: name: type: string options: description: Options for a waitForEvent step. type: - object - 'null' properties: event_type: type: string timeout: description: Duration as milliseconds (number) or human-readable string. anyOf: - type: number - type: string required: - event_type - timeout payload: description: Shape descriptor for JSON payloads. anyOf: - properties: type: type: string enum: - unknown required: - type type: object - properties: fields: description: Nested JsonShape fields (recursive structure). type: object additionalProperties: type: object type: type: string enum: - object required: - type - fields type: object resolves: type: number starts: type: number type: type: string enum: - step_wait_for_event required: - type - name - options type: object - properties: name: type: string resolves: type: number starts: type: number timestamp: type: string type: type: string enum: - step_sleep_until required: - type - name - timestamp type: object - properties: nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - loop required: - type - nodes type: object - properties: kind: description: Parallel execution strategy. type: string enum: - all - any - all_settled - race nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - parallel required: - type - kind - nodes type: object - properties: catch_block: type: - object - 'null' properties: nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - block required: - type - nodes finally_block: type: - object - 'null' properties: nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - block required: - type - nodes try_block: type: - object - 'null' properties: nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - block required: - type - nodes type: type: string enum: - try required: - type - try_block - catch_block - finally_block type: object - properties: nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - block required: - type - nodes type: object - properties: branches: type: array items: properties: condition: type: - string - 'null' nodes: description: Child nodes (recursive). type: array items: type: object required: - condition - nodes type: object type: type: string enum: - if required: - type - branches type: object - properties: branches: type: array items: properties: condition: type: - string - 'null' nodes: description: Child nodes (recursive). type: array items: type: object required: - condition - nodes type: object discriminant: type: string type: type: string enum: - switch required: - type - discriminant - branches type: object - properties: class_name: type: string functions: type: object additionalProperties: properties: name: type: string nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - function_def required: - type - name - nodes type: object nodes: description: Child nodes (recursive). type: array items: type: object payload: description: Shape descriptor for JSON payloads. anyOf: - properties: type: type: string enum: - unknown required: - type type: object - properties: fields: description: Nested JsonShape fields (recursive structure). type: object additionalProperties: type: object type: type: string enum: - object required: - type - fields type: object type: type: string enum: - start required: - type - class_name - functions - nodes type: object - properties: name: type: string resolves: type: number starts: type: number type: type: string enum: - function_call required: - type - name type: object - properties: name: type: string nodes: description: Child nodes (recursive). type: array items: type: object type: type: string enum: - function_def required: - type - name - nodes type: object - properties: kind: description: Break or return from a loop. type: string enum: - break - return type: type: string enum: - break required: - type - kind type: object payload: description: Shape descriptor for JSON payloads. anyOf: - properties: type: type: string enum: - unknown required: - type type: object - properties: fields: description: Nested JsonShape fields (recursive structure). type: object additionalProperties: type: object type: type: string enum: - object required: - type - fields type: object required: - class_name - functions - nodes required: - version - workflow id: type: string format: uuid modified_on: type: string format: date-time workflow_id: type: string format: uuid required: - created_on - modified_on - id - workflow_id - class_name - graph result_info: type: object properties: count: type: number cursor: type: string page: type: number per_page: type: number total_count: type: number total_pages: type: number required: - per_page - count - total_count success: type: boolean enum: - true required: - success - errors - result - messages '404': description: Version not found. content: application/json: schema: type: object properties: errors: type: array items: properties: code: type: number message: type: string required: - code - message type: object messages: type: array items: type: string result: type: - object - 'null' enum: - null success: type: boolean enum: - false required: - success - messages - errors - result security: - api_email: [] api_key: [] api_token: [] tags: - Workflows x-api-token-group: - Workers Tail Read - Workers Scripts Write - Workers Scripts Read x-cfPermissionsRequired: enum: - com.cloudflare.api.workers.write - com.cloudflare.api.workers.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: workflows.versions x-fern-sdk-method-name: graph components: securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey api_key: in: header name: X-Auth-Key type: apiKey api_token: scheme: bearer type: http user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey externalDocs: description: Cloudflare Radar Documentation url: https://developers.cloudflare.com/radar/ x-forge-commands: abuse-reports: description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites groups: appeals: description: Appeal eligibility for abuse reports emails: description: Emails sent for abuse reports mitigations: description: Mitigation actions taken in response to abuse reports accounts: description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account groups: applications: description: Applications operations categories: description: Categories operations organizations: description: Move accounts between organizations profile: description: View and manage the profile for a Cloudflare account roles: description: View the roles available for assigning to account members, each defining a set of permissions subscriptions: description: View and manage plan subscriptions attached to this account tokens: description: Create and manage scoped API tokens for programmatic access to the Cloudflare API ai-gateway: description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more groups: custom-domains: description: Manage custom hostnames that route requests through an AI Gateway custom-providers: description: Manage account-level custom AI providers and their endpoint settings datasets: description: 'Deprecated: manage filtered collections of gateway logs used by evaluations' dynamic-routing: description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments dynamic-routing.deployments: description: Deploy dynamic route versions and view deployment history dynamic-routing.versions: description: Create and inspect saved versions of a dynamic route evaluation-types: description: 'Deprecated: list the evaluator types that evaluations can use' evaluations: description: 'Deprecated: score the logs in a dataset with selected evaluator types' gateways: description: Create and configure AI Gateways for an account gateways.providers: description: Store and rotate upstream AI provider keys for a gateway logs: description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs ai-search: description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions' groups: items: description: Content indexed by AI Search instances jobs: description: Indexing job lifecycle for AI Search instances namespace: description: Logical groupings for organizing AI Search instances tokens: description: Credentials used by AI Search instances ai-security: description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications groups: custom-topics: description: Organization-specific topic categories used by AI Security for Apps content detection analytics: description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics groups: colo: description: Per-data-center (colo) traffic analytics breakdown for the zone dashboard: description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views latency: description: Argo Smart Routing latency analytics showing time-to-first-byte improvements argo: description: Network optimization features that speed up and improve reliability of traffic to your origins groups: smart-routing: description: Route traffic through the fastest network paths to your origin using real-time latency data tiered-caching: description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin basin-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables billing: description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services groups: profiles: description: Billing profile with payment method, address, and invoice preferences usage: description: Metered usage data for billed services — requests, bandwidth, and feature consumption botnet-feed: description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure groups: asn: description: ASN-level botnet activity data showing networks with known C2 infrastructure configs: description: Botnet feed subscription configuration and notification preferences builds: description: Build and deploy Workers from connected repositories, then inspect build status and logs. groups: deploy-hooks: description: Manage branch-specific HTTP hooks that start builds. limits: description: View build-minute availability and refresh information. logs: description: Retrieve build logs. repos: description: Manage source repository connections for Workers Builds. tokens: description: Manage credentials used by Workers Builds to deploy Workers. triggers: description: Configure how repository changes build and deploy Workers. versions: description: Find builds associated with Worker versions. workers: description: Manage repository-backed build configuration for Workers. cache: description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving groups: origin-cloud-regions: description: Manage Origin Cloud Regions routing and failover configurations settings: description: Configure Cache Reserve, tiered caching, and variant serving settings.regional-tiered-cache: description: Restrict tiered cache topology to data centers within a specific geographic region settings.reserve: description: Persistent storage tier that keeps cached assets even after eviction from edge caches settings.smart-tiered-cache: description: Automatically determine the best upper-tier data centers for tiered cache topology settings.variants: description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.) client-side-security: description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks groups: connections: description: Third-party connections made by scripts on your pages — track data exfiltration risks cookies: description: Cookies set by your pages with classification and same-site attribute tracking policies: description: Content Security Policies that control which scripts and connections are allowed on your pages scripts: description: JavaScript files detected on your pages with change tracking and malicious code detection settings: description: Fine tune Client-Side Security behaviors cloud-connector: description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers groups: rules: description: Routing rules that map request patterns to cloud provider endpoints cloudforce-one: description: Detection rule management APIs groups: binary-storage: description: Upload and retrieve malware samples and suspicious binaries for analysis requests: description: Additional request operations — priority listing and asset creation rules: description: Rule management operations groups: approvals: description: Approval workflow operations email: description: Email rule operations exemptions: description: Exemption rule operations managed: description: Managed rule operations stats: description: Rule statistics operations tree: description: Rule navigation tree operations scans: description: Scan URLs, IPs, and domains for threat intelligence indicators containers: description: Deploy and manage Containers applications on Cloudflare's global network groups: applications: description: Manage Containers applications applications.instances: description: Inspect Containers instances belonging to applications applications.rollouts: description: Manage rollouts for scheduler-backed applications applications.versions: description: Inspect versions of scheduler-backed applications registries: description: Manage Containers image registries registries.credentials: description: Generate image registry credentials content-scan: description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads groups: expressions: description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own custom-pages: description: Manage custom error and challenge pages and their assets for accounts and zones groups: account-custom-pages: description: Manage account-level custom pages account-custom-pages.preview-tokens: description: Preview tokens for account-level custom pages assets: description: Manage account- and zone-level custom assets zone-custom-pages: description: Manage zone-level custom pages zone-custom-pages.preview-tokens: description: Preview tokens for zone-level custom pages d1: description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access. groups: time-travel: description: use specific point-in-time backups of your D1 database x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel diagnostics: description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks groups: endpoint-healthchecks: description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks traceroutes: description: Run traceroutes from Cloudflare data centers to diagnose network path issues email-routing: description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records groups: addresses: description: Verified destination email addresses that can receive forwarded mail dns: description: Inspect or unlock the DNS records required by Email Routing rules: description: Match incoming email addresses and forward messages to destination mailboxes or Workers settings: description: Inspect and update Email Routing settings email-security: description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing groups: analytics: description: Analytics and reporting — monthly report and per-day breakdowns of threat activity bulk-actions: description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs investigate: description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions phishguard: description: PhishGuard user-reported phishing reports — view detected threats for a date range settings: description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling submissions: description: Reclassify submissions — track user and team reports of false positives and missed detections email-sending: description: Send transactional email and manage sending subdomains and their DNS configuration groups: limits: description: Inspect account-level sending quotas and current usage subdomains: description: Configure sending subdomains and keep their DNS records healthy suppressions: description: Prevent delivery to suppressed addresses and manage the account suppression list filters: description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations firewall: description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages groups: access-rules: description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone lockdowns: description: Zone lockdown rules that restrict access to URLs by IP address or range rules: description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations ua-rules: description: Block or challenge requests based on the User-Agent header string waf: description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations zone-access-rules: description: Zone-scoped IP access rules for blocking or allowing traffic google-tag-gateway: description: Google Tag Gateway operations groups: config: description: Google Tag Gateway config operations healthchecks: description: Standalone health checks that monitor origin server availability from Cloudflare's edge groups: previews: description: Test a health check configuration before deploying it to production hyperdrive: description: Accelerate access to existing databases by caching queries and pooling connections at the edge iam: description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors groups: permission-groups: description: View the permission groups that can be assigned to API tokens and policies resource-groups: description: Define scopes that limit which account resources a policy or token can access sso: description: Configure single sign-on connectors to authenticate account members through an external identity provider user-groups: description: Organize account members into groups for easier permission assignment images: description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads groups: flows: description: Zone-level transformation flows that control how images are resized and optimized on delivery import: description: Import images from S3 keys: description: Manage signing keys for generating private image URLs variants: description: Manage named resize variants for transforming images on delivery intel: description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds groups: asn: description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems attack-surface-report: description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping dns: description: Passive DNS data showing historical DNS resolution records for domains domain-history: description: Historical domain registration and categorization changes over time domains: description: Domain intelligence — risk scores, categories, and associated infrastructure indicator-feeds: description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs ip-lists: description: Curated IP lists used for threat detection and policy enforcement ips: description: IP address intelligence — geolocation, risk assessment, and hosting provider details miscategorizations: description: Report and track domain miscategorization corrections whois: description: WHOIS registration data for domains including registrant, registrar, and nameservers k2: description: Durable, ordered event streams that you produce records to and consume from with subscriptions groups: streams: description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records streams.subscriptions: description: Subscriptions that consume a K2 stream, with committed-position lag leaked-credential-checks: description: Detect compromised credentials in login requests by checking against known breach databases groups: detections: description: Custom detection locations that tell the WAF where to find usernames and passwords in requests load-balancers: description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover groups: monitor-groups: description: Group monitors together for shared configuration and bulk management monitor-groups.references: description: List references to monitor groups used by load balancer pools monitors: description: Health check configurations that probe origin servers and determine pool availability monitors.previews: description: Health check configurations that probe origin servers and determine pool availability monitors.references: description: Health check configurations that probe origin servers and determine pool availability pools: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.health: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.references: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences previews: description: Preview the result of a health check monitor configuration before applying it regions: description: Geographic regions used for regional pool steering and traffic policies searches: description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference logs: description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields groups: control: description: Log control operations received: description: Received log operations magic-network-monitoring: description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion groups: configs: description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings rules: description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements vpc-flows: description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection magic-transit: description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures groups: advanced-dns-protection: description: Advanced Dns Protection operations advanced-tcp-protection: description: Advanced Tcp Protection operations apps: description: Application-aware traffic policies for Magic WAN that steer traffic by app type bgp-filter-profiles: description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels bgp-settings: description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels cf-interconnects: description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering gre-tunnels: description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit ipsec-tunnels: description: IPsec tunnel endpoints with pre-shared key management for encrypted transit pcaps: description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels routes: description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels sites: description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config mcp: description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls groups: portals: description: Manage MCP portals, attached servers, and Code Mode settings servers: description: Manage upstream MCP servers, credentials, capabilities, and sync state network-interconnects: description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network groups: cnis: description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare interconnects: description: Physical cross-connect and partner interconnect sessions with LOA and status tracking settings: description: Account-level interconnect settings and default configurations slots: description: Available interconnect facility slots showing port capacity at Cloudflare data centers organizations: description: Multi-user organizations that group accounts, members, and shared settings under a single entity groups: account-organizations: description: List organizations associated with a specific account accounts: description: Accounts operations members: description: Members operations members-batch-create: description: Members Batch Create operations organization-profile: description: View and update the public profile information for an organization shares: description: Shares operations origin-post-quantum-encryption: description: Enable post-quantum key exchange for connections between Cloudflare and your origin server pages: description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains groups: projects: description: Pages projects, deployments, build logs, and custom domain bindings pipelines: description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time groups: sinks: description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage streams: description: Inbound data streams that feed events into a pipeline for processing precursor: description: Precursor settings for a zone queues: description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale groups: consumers: description: Workers that automatically receive and process messages from a queue messages: description: Push messages to a queue and pull or acknowledge them from consumers purge: description: Remove all pending messages from a queue subscriptions: description: Manage queue subscriptions for event-driven message routing r2: description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration groups: buckets: description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks buckets.jobs: description: Create and inspect background jobs for an R2 bucket buckets.local-uploads: description: R2 bucket local upload configuration super-slurper: description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs temporary-credentials: description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations r2-data-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables radar: description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights groups: agent-readiness: description: Agent readiness summary statistics across the Cloudflare network ai: description: AI inference trends and model usage statistics across the Cloudflare network annotations: description: Radar annotations marking significant Internet events (outages, cable cuts, etc.) as112: description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space attacks: description: DDoS and application-layer attack trends, vectors, and target analysis bgp: description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events bots: description: Internet-wide bot traffic trends, categories, and distribution statistics ct: description: Certificate Transparency log monitoring and newly-issued certificate discovery datasets: description: Downloadable Radar datasets for offline analysis and research dns: description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption email: description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics entities: description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries geolocations: description: Geographic location metadata used for regional traffic analysis http: description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution leaked-credentials: description: Leaked credential detection trends and exposure statistics netflows: description: Network-layer traffic flow data and volumetric trend analysis origins: description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics post-quantum: description: Post-quantum encryption adoption and deployment trends across the Internet quality: description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN ranking: description: Top domain rankings based on DNS query popularity across the Cloudflare network robots-txt: description: Robots.txt adoption and crawler directive trends across the web search: description: Search Radar data across IPs, ASNs, domains, and locations tcp-resets-timeouts: description: TCP connection reset and timeout statistics indicating network health issues tlds: description: Top-level domain (TLD) metadata and performance trends traffic-anomalies: description: Detected traffic anomalies and unusual patterns in Internet traffic flows verified-bots: description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns rate-limits: description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations realtime: description: Real-time audio, video, and data services on Cloudflare's global network groups: kit: description: SDK-backed meetings, participants, recordings, livestreams, and webhooks kit.analytics: description: Usage and livestream analytics for RealtimeKit applications kit.analytics.livestreams: description: Livestream analytics for RealtimeKit applications kit.analytics.livestreams.daily: description: Daily livestream analytics for RealtimeKit applications kit.analytics.usage: description: Usage analytics for RealtimeKit applications kit.apps: description: RealtimeKit applications that group meetings, sessions, and configuration kit.livestreams: description: Independent and meeting-based livestreams and their sessions kit.livestreams.sessions: description: Sessions for RealtimeKit livestreams kit.meetings: description: Meetings, participants, access tokens, and meeting livestreams kit.meetings.active: description: Live meeting state and participant controls kit.meetings.active.polls: description: Polls for active meeting sessions kit.meetings.livestream: description: Livestream operations associated with RealtimeKit meetings kit.meetings.participants: description: Participants in RealtimeKit meetings kit.meetings.participants.tokens: description: Access tokens for RealtimeKit meeting participants kit.presets: description: Reusable meeting configuration for media, permissions, and interface behavior kit.recordings: description: Meeting and participant-track recordings and recording controls kit.recordings.active: description: Active recordings for RealtimeKit meetings kit.recordings.tracks: description: Participant-track recordings for RealtimeKit meetings kit.sessions: description: Historical session data, participants, chat, transcripts, and summaries kit.sessions.chat: description: Chat messages from historical RealtimeKit sessions kit.sessions.livestreams: description: Livestreams associated with historical RealtimeKit sessions kit.sessions.participants: description: Participants in historical RealtimeKit sessions kit.sessions.peers: description: Peer details from historical RealtimeKit sessions kit.sessions.summaries: description: Summaries of historical RealtimeKit sessions kit.sessions.transcripts: description: Transcripts from historical RealtimeKit sessions kit.webhooks: description: Webhook endpoints and supported events for RealtimeKit notifications kit.webhooks.events: description: Supported events for RealtimeKit webhooks moq: description: MoQ relays for publishing and subscribing to media streams moq.relays: description: Relays are isolated MoQ scopes that carry media between publishers and subscribers moq.relays.tokens: description: Tokens that authorize publishers and subscribers to connect to a relay sfu: description: SFU apps that route WebRTC media and data between participants sfu.apps: description: SFU application namespaces for sessions and tracks turn: description: TURN keys that help clients traverse NATs and firewalls turn.keys: description: Keys used to generate short-lived TURN credentials request-tracers: description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline groups: traces: description: Simulate request processing to debug rule matches, transforms, and routing decisions resource-sharing: description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls groups: recipients: description: Update share recipients resources: description: Individual resources (zones, configs) that have been shared with recipients rules: description: Resources used by Cloudflare rules and rulesets groups: lists: description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions rum: description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics groups: rules: description: Rules that control which pages and paths are tracked by Web Analytics site-info: description: Web Analytics sites — register domains and get the JavaScript beacon snippet scim: description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account groups: groups: description: Groups operations resource-types: description: Resource Types operations schemas: description: Schemas operations service-provider-config: description: Service Provider Config operations users: description: Users operations secrets-store: description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products groups: quota: description: Account quota limits for secrets stores, secrets count, and storage capacity secrets: description: Encrypted key-value secrets within a store. Pass --store-id to scope. stores: description: Secret stores that hold encrypted key-value secrets accessible by Workers and services security-center: description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities groups: insights: description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc. zone-insights: description: Zone-scoped security insights — counts by class, severity, type, and dismissal security-txt: description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities smart-shield: description: Smart Shield settings, health checks, and cache reserve management groups: cache-reserve-clear: description: Cache Reserve Clear operations health-checks: description: Health checks operations spectrum: description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation groups: analytics: description: Real-time and historical connection analytics for Spectrum applications apps: description: Spectrum application configurations that map protocols and ports to origin servers speed: description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests groups: availabilities: description: Check which speed test regions and configurations are available for your zone pages: description: Tested pages with their performance history, trends, and individual test results schedule: description: Scheduled recurring speed tests that automatically run at regular intervals ssl: description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations groups: automatic-upgrader: description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings recommendations: description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration stream: description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale groups: audio-tracks: description: Add, edit, or remove additional audio tracks on a video captions: description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages clip: description: Create a new video clip from an existing video by specifying start and end times copy: description: Import a video from a URL into Stream for processing and delivery direct-upload: description: Generate a tokenized URL that lets end-users upload video directly to Stream downloads: description: Create downloadable MP4 renditions of a video for offline viewing embed: description: Retrieve the HTML embed code snippet for a video keys: description: Signing keys used to generate short-lived signed URLs for private video playback live-inputs: description: Enable and disable live input streams token: description: Generate short-lived signed URL tokens for secure private video playback typed-downloads: description: Type-specific stream download creation and deletion videos: description: Aggregate video storage usage statistics for the account watermarks: description: Watermark profiles that overlay an image on every video in the account webhooks: description: Webhook notifications for video lifecycle events (ready, error, etc.) tenants: description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships groups: account-types: description: Account Types operations accounts: description: Accounts operations entitlements: description: Entitlements operations memberships: description: Memberships operations turnstile: description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience groups: widgets: description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings url-scanner: description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results groups: response: description: Response operations responses: description: Raw HTTP response data captured during URL scans scan: description: Scan operations scans: description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts user: description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens groups: billing: description: View billing history and payment profile for your user (deprecated — prefer account-level billing) firewall: description: Firewall operations load-balancers.monitors: description: Load Balancers operations load-balancers.monitors.preview: description: Load Balancers operations load-balancers.monitors.references: description: Load Balancers operations load-balancers.pools: description: Load Balancers operations load-balancers.pools.edit.pools: description: Load Balancers operations load-balancers.pools.health: description: Load Balancers operations load-balancers.pools.preview: description: Load Balancers operations load-balancers.pools.references: description: Load Balancers operations load-balancers.preview: description: Load Balancers operations load-balancing-analytics.events: description: Load Balancing Analytics operations subscriptions: description: View and manage zone-level plan subscriptions owned by your user tenants: description: Tenants operations tokens: description: Create and manage personal API tokens scoped to your user for programmatic API access user.analytics: description: User-level traffic analytics — aggregated totals and timeseries across all zones vectorize: description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers groups: deprecated-indexes: description: Deprecated v1 Vectorize index operations metadata-index: description: Metadata indexes for filtered vector search waiting-rooms: description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages groups: account-waiting-rooms: description: Account-scoped waiting room listing events: description: Scheduled events that temporarily override waiting room settings for sales, launches, etc. page: description: Custom HTML waiting page templates and preview rendering rules: description: Rules that bypass or modify waiting room behavior for specific request patterns settings: description: Zone-level waiting room defaults and cookie configuration statuses: description: Real-time queue status showing active users, queued users, and estimated wait times workflows: description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence groups: instances: description: Workflow instance operations versions: description: Workflow version operations zaraz: description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS groups: config: description: Full Zaraz configuration including tools, triggers, and variables for the zone default: description: Default Zaraz configuration template used as a starting point for new zones export: description: Export the current Zaraz configuration as a portable JSON document history: description: Configuration version history — browse and restore previous Zaraz configurations publish: description: Publish pending Zaraz configuration changes to make them live on the zone workflow: description: Workflow state for Zaraz configuration changes (draft vs. published) zero-trust: description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation groups: dex: description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics dlp.custom-prompt-topics: description: Data Loss Prevention - manage custom prompt topics for AI-based content detection dlp.data-classes: description: Data Loss Prevention - manage data classes used to classify sensitive information dlp.data-tag-categories: description: Data Loss Prevention - manage categories that organize data tags dlp.data-tag-category-templates: description: Data Loss Prevention - browse templates for creating data tag categories dlp.data-tags: description: Data Loss Prevention - manage tags used to classify and organize sensitive data dlp.datasets: description: Data Loss Prevention - manage datasets, versions, and uploads dlp.document-fingerprints: description: Data Loss Prevention - manage document fingerprints for detecting matching documents dlp.email.account-mapping: description: Data Loss Prevention - configure account mappings for outbound email scanning dlp.email.rules: description: Data Loss Prevention - manage outbound email scanning rules and their priorities dlp.entries: description: Data Loss Prevention - list and manage detection entries dlp.limits: description: Data Loss Prevention - view account limits and resource quotas dlp.patterns: description: Data Loss Prevention - validate regular expressions used for content detection dlp.profiles: description: Data Loss Prevention - list and retrieve profiles dlp.profiles.custom: description: Data Loss Prevention - manage custom profiles dlp.profiles.predefined: description: Data Loss Prevention - manage predefined profiles dlp.sensitivity-group-templates: description: Data Loss Prevention - browse templates for creating sensitivity groups dlp.sensitivity-groups: description: Data Loss Prevention - manage sensitivity groups and their level ordering dlp.sensitivity-levels: description: Data Loss Prevention - manage sensitivity levels within sensitivity groups dlp.settings: description: Data Loss Prevention - manage account-level settings dlp.validators: description: Data Loss Prevention - list and retrieve content validators dlp.validators.proximity-words: description: Data Loss Prevention - manage proximity-word validators risk-scoring: description: User Risk Scoring - retrieve and reset user risk scores risk-scoring.behaviours: description: User Risk Scoring - manage behaviors used to calculate user risk scores risk-scoring.integrations: description: User Risk Scoring - manage integrations that provide risk score signals risk-scoring.integrations.references: description: User Risk Scoring - retrieve integrations by external reference risk-scoring.summary: description: User Risk Scoring - retrieve account risk score summaries zones: description: Zones are domains on Cloudflare — list, create, and configure domain settings groups: aegis: description: Aegis operations fonts: description: Fonts operations origin-h2-max-streams: description: Origin H2 Max Streams operations origin-max-http-version: description: Origin Max Http Version operations origin-tls-compliance-modes: description: Manage zone Origin TLS Compliance Modes setting rum: description: Rum operations speed-brain: description: Speed Brain operations