accounts_pipelines

Creates, updates, deletes, gets or lists an accounts_pipelines resource.

Overview

Name	accounts_pipelines
Type	Resource
Id	cloudflare.pipelines.accounts_pipelines

Fields

The following fields are returned by SELECT queries:

get_by_account

[DEPRECATED] Describes the configuration of a pipeline.

Name	Datatype	Description
id	string	Specifies the pipeline identifier. (example: 123f8a8258064ed892a347f173372359)
name	string	Defines the name of the pipeline. (example: sample_pipeline)
destination	object
endpoint	string	Indicates the endpoint URL to send traffic. (example: https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com)
source	array
version	number	Indicates the version number of last saved configuration.

list

[DEPRECATED] Lists the pipelines. Use /pipelines/v1/pipelines instead.

Name	Datatype	Description
id	string	Specifies the pipeline identifier. (example: 123f8a8258064ed892a347f173372359)
name	string	Defines the name of the pipeline. (example: sample_pipeline)
destination	object
endpoint	string	Indicates the endpoint URL to send traffic. (example: https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com)
source	array
version	number	Indicates the version number of last saved configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_account	select	account_id, pipeline_name		[DEPRECATED] Get configuration of a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
list	select	account_id	search, page, per_page	[DEPRECATED] List, filter, and paginate pipelines in an account. Use the new /pipelines/v1/pipelines endpoint instead.
create	insert	account_id, name, source, destination		[DEPRECATED] Create a new pipeline. Use the new /pipelines/v1/pipelines endpoint instead.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
pipeline_name	string
page	string
per_page	string
search	string

SELECT examples

get_by_account

[DEPRECATED] Get configuration of a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.

SELECT
id,
name,
destination,
endpoint,
source,
version
FROM cloudflare.pipelines.accounts_pipelines
WHERE account_id = '{{ account_id }}' -- required
AND pipeline_name = '{{ pipeline_name }}' -- required
;

list

[DEPRECATED] List, filter, and paginate pipelines in an account. Use the new /pipelines/v1/pipelines endpoint instead.

SELECT
id,
name,
destination,
endpoint,
source,
version
FROM cloudflare.pipelines.accounts_pipelines
WHERE account_id = '{{ account_id }}' -- required
AND search = '{{ search }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create

[DEPRECATED] Create a new pipeline. Use the new /pipelines/v1/pipelines endpoint instead.

INSERT INTO cloudflare.pipelines.accounts_pipelines (
destination,
name,
source,
account_id
)
SELECT 
'{{ destination }}' /* required */,
'{{ name }}' /* required */,
'{{ source }}' /* required */,
'{{ account_id }}'
RETURNING
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: accounts_pipelines
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the accounts_pipelines resource.
  - name: destination
    value:
      batch:
        max_bytes: {{ max_bytes }}
        max_duration_s: {{ max_duration_s }}
        max_rows: {{ max_rows }}
      compression:
        type: "{{ type }}"
      credentials:
        access_key_id: "{{ access_key_id }}"
        endpoint: "{{ endpoint }}"
        secret_access_key: "{{ secret_access_key }}"
      format: "{{ format }}"
      path:
        bucket: "{{ bucket }}"
        filename: "{{ filename }}"
        filepath: "{{ filepath }}"
        prefix: "{{ prefix }}"
      type: "{{ type }}"
  - name: name
    value: "{{ name }}"
    description: |
      Defines the name of the pipeline.
  - name: source
    value:
      - authentication: {{ authentication }}
        cors:
          origins:
            - "{{ origins }}"
        format: "{{ format }}"
        type: "{{ type }}"