Pipelines

pipelines

Methods

Create Pipeline -> Envelope<{ id, destination, endpoint, 3 more... }>
post/accounts/{account_id}/pipelines

Create a new pipeline.

Delete Pipeline ->
delete/accounts/{account_id}/pipelines/{pipeline_name}

Delete a pipeline.

Get Pipeline -> Envelope<{ id, destination, endpoint, 3 more... }>
get/accounts/{account_id}/pipelines/{pipeline_name}

Get configuration of a pipeline.

List Pipelines -> { result_info, results, success }
get/accounts/{account_id}/pipelines

List, filter, and paginate pipelines in an account.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Pipelines Write Pipelines Read

path Parameters
account_id: string

Specifies the public ID of the account.

query Parameters
page: string
Optional
(default: "1")

Specifies which page to retrieve.

per_page: string
Optional
(default: "25")

Specifies the number of pipelines per page.

search: string
Optional

Specifies the prefix of pipeline name to search.

Response fields
result_info: { count, page, per_page, 1 more... }
results: Array<{ id, destination, endpoint, 3 more... }>
success: boolean

Indicates whether the API call was successful.

Request example
200Example
Update Pipeline -> Envelope<{ id, destination, endpoint, 3 more... }>
put/accounts/{account_id}/pipelines/{pipeline_name}

Update an existing pipeline.