--- title: [DEPRECATED] Get Pipeline --- [Skip to content](#%5Ftop) [API Reference](https://developers.cloudflare.com/api/typescript) [Pipelines](https://developers.cloudflare.com/api/typescript/resources/pipelines) Copy Markdown Open in **Claude** Open in **ChatGPT** Open in **Cursor** --- **Copy Markdown** **View as Markdown** # \[DEPRECATED\] Get Pipeline Deprecated: Use get\_v1 instead. This endpoint will be removed in the future. client.pipelines.get(stringpipelineName, PipelineGetParams { account\_id } params, RequestOptionsoptions?): [PipelineGetResponse](https://developers.cloudflare.com/api/typescript/resources/pipelines#%28resource%29%20pipelines%20%3E%20%28model%29%20pipeline%5Fget%5Fresponse%20%3E%20%28schema%29) { id, destination, endpoint, 3 more } GET/accounts/{account\_id}/pipelines/{pipeline\_name} \[DEPRECATED\] Get configuration of a pipeline. Use the new /pipelines/v1/pipelines endpoint instead. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**`X-Auth-Email: user@example.com` The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194` ##### Accepted Permissions (at least one required) `Pipelines Write` `Pipelines Read` ##### ParametersExpand Collapse pipelineName: string Defines the name of the pipeline. maxLength128 minLength1 params: PipelineGetParams { account\_id } account\_id: string Specifies the public ID of the account. ##### ReturnsExpand Collapse PipelineGetResponse { id, destination, endpoint, 3 more } \[DEPRECATED\] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead. id: string Specifies the pipeline identifier. destination: Destination { batch, compression, format, 2 more } batch: Batch { max\_bytes, max\_duration\_s, max\_rows } max\_bytes: number Specifies rough maximum size of files. maximum100000000 minimum1000 max\_duration\_s: number Specifies duration to wait to aggregate batches files. maximum300 minimum0.25 max\_rows: number Specifies rough maximum number of rows per file. maximum10000000 minimum100 compression: Compression { type } type: "none" | "gzip" | "deflate" Specifies the desired compression algorithm and format. One of the following: "none" "gzip" "deflate" format: "json" Specifies the format of data to deliver. path: Path { bucket, filename, filepath, prefix } bucket: string Specifies the R2 Bucket to store files. filename?: string Specifies the name pattern to for individual data files. filepath?: string Specifies the name pattern for directory. prefix?: string Specifies the base directory within the bucket. type: "r2" Specifies the type of destination. endpoint: string Indicates the endpoint URL to send traffic. name: string Defines the name of the pipeline. maxLength128 minLength1 source: Array One of the following: CloudflarePipelinesWorkersPipelinesHTTPSource { format, type, authentication, cors } \[DEPRECATED\] HTTP source configuration. Use the new streams API instead. format: "json" Specifies the format of source data. type: string authentication?: boolean Specifies whether authentication is required to send to this pipeline via HTTP. cors?: CORS { origins } origins?: Array Specifies allowed origins to allow Cross Origin HTTP Requests. CloudflarePipelinesWorkersPipelinesBindingSource { format, type } \[DEPRECATED\] Worker binding source configuration. Use the new streams API instead. format: "json" Specifies the format of source data. type: string version: number Indicates the version number of last saved configuration. ### \[DEPRECATED\] Get Pipeline TypeScript HTTPHTTP TypeScriptTypeScript PythonPython GoGo TerraformTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const pipeline = await client.pipelines.get('sample_pipeline', { account_id: '0123105f4ecef8ad9ca31a8372d0c353', }); console.log(pipeline.id); ``` 200 example ``` { "result": { "id": "123f8a8258064ed892a347f173372359", "destination": { "batch": { "max_bytes": 1000, "max_duration_s": 0.25, "max_rows": 100 }, "compression": { "type": "gzip" }, "format": "json", "path": { "bucket": "bucket", "filename": "${slug}${extension}", "filepath": "${date}/${hour}", "prefix": "base" }, "type": "r2" }, "endpoint": "https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com", "name": "sample_pipeline", "source": [ { "format": "json", "type": "type", "authentication": true, "cors": { "origins": [ "*" ] } } ], "version": 2 }, "success": true } ``` ##### Returns Examples 200 example ``` { "result": { "id": "123f8a8258064ed892a347f173372359", "destination": { "batch": { "max_bytes": 1000, "max_duration_s": 0.25, "max_rows": 100 }, "compression": { "type": "gzip" }, "format": "json", "path": { "bucket": "bucket", "filename": "${slug}${extension}", "filepath": "${date}/${hour}", "prefix": "base" }, "type": "r2" }, "endpoint": "https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com", "name": "sample_pipeline", "source": [ { "format": "json", "type": "type", "authentication": true, "cors": { "origins": [ "*" ] } } ], "version": 2 }, "success": true } ```