--- title: List Logpush jobs --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Logpush](https://developers.cloudflare.com/api/resources/logpush) [Jobs](https://developers.cloudflare.com/api/resources/logpush/subresources/jobs) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Logpush jobs GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/jobs Lists Logpush jobs for an account or zone. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a 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) `Logs Write` ##### P ath ParametersExpand Collapse account\_id: optional string The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. [Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) zone\_id: optional string The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. [Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional array of LogpushJob { id, dataset, destination\_conf, 13 more } id: optional number Unique id of the job. minimum1 Link to this property
dataset: optional "access\_requests"or "account\_abuse\_protection\_events"or "audit\_logs"or 34 more Name of the dataset. A list of supported datasets can be found on the Developer Docs. One of the following: "access\_requests" Link to this property "account\_abuse\_protection\_events" Link to this property "audit\_logs" Link to this property "audit\_logs\_v2" Link to this property "biso\_user\_actions" Link to this property "casb\_findings" Link to this property "device\_posture\_results" Link to this property "dex\_application\_tests" Link to this property "dex\_device\_state\_events" Link to this property "dlp\_forensic\_copies" Link to this property "dns\_firewall\_logs" Link to this property "dns\_logs" Link to this property "email\_security\_alerts" Link to this property "email\_security\_post\_delivery\_events" Link to this property "firewall\_events" Link to this property "gateway\_dns" Link to this property "gateway\_http" Link to this property "gateway\_network" Link to this property "http\_requests" Link to this property "ipsec\_logs" Link to this property "magic\_bgp\_logs" Link to this property "magic\_ids\_detections" Link to this property "mcp\_portal\_logs" Link to this property "mnm\_flow\_logs" Link to this property "nel\_reports" Link to this property "network\_analytics\_logs" Link to this property "page\_shield\_events" Link to this property "sinkhole\_http\_logs" Link to this property "spectrum\_events" Link to this property "ssh\_logs" Link to this property "turnstile\_events" Link to this property "warp\_config\_changes" Link to this property "warp\_toggle\_changes" Link to this property "websocket\_analytics" Link to this property "workers\_trace\_events" Link to this property "zaraz\_events" Link to this property "zero\_trust\_network\_sessions" Link to this property
Link to this property destination\_conf: optional string Uniquely identifies a resource (such as an s3 bucket) where data. will be pushed. Additional configuration parameters supported by the destination may be included. formaturi maxLength4096 Link to this property enabled: optional boolean Flag that indicates if the job is enabled. Link to this property error\_message: optional string If not null, the job is currently failing. Failures are usually. repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error\_message and last\_error are set to null. Link to this property filter\_attack\_traffic: optional boolean When true, excludes DDoS attack traffic from logs. This option is supported for the http_requests, firewall_events, and network_analytics_logs datasets. Link to this property
Deprecatedfrequency: optional "high"or "low" This field is deprecated. Please use max_upload_* parameters instead. . The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files. One of the following: "high" Link to this property "low" Link to this property
Link to this property
kind: optional ""or "edge" The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset). One of the following: "" Link to this property "edge" Link to this property
Link to this property last\_complete: optional string Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn’t run yet then the field will be empty. formatdate-time Link to this property last\_error: optional string Records the last time the job failed. If not null, the job is currently. failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error\_message field. formatdate-time Link to this property Deprecatedlogpull\_options: optional string This field is deprecated. Use output_options instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately. formaturi-reference maxLength4096 Link to this property
max\_upload\_bytes: optional 0or number The maximum uncompressed file size of a batch of logs. This setting value must be between 5 MB and 1 GB, or 0 to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size. One of the following: 0 The maximum uncompressed file size of a batch of logs. This setting value must be between 5 MB and 1 GB, or 0 to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size. Link to this property number Link to this property
Link to this property
max\_upload\_interval\_seconds: optional 0or number The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or 0 to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this. One of the following: 0 The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or 0 to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this. Link to this property number Link to this property
Link to this property
max\_upload\_records: optional 0or number The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or 0 to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this. One of the following: 0 The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or 0 to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this. Link to this property number Link to this property
Link to this property name: optional string Optional human readable job name. Not unique. Cloudflare suggests. that you set this to a meaningful string, like the domain name, to make it easier to identify your job. maxLength512 Link to this property
output\_options: optional OutputOptions { batch\_prefix, batch\_suffix, CVE-2021-44228, 10 more } The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored. batch\_prefix: optional string String to be prepended before each batch. Link to this property batch\_suffix: optional string String to be appended after each batch. Link to this property "CVE-2021-44228": optional boolean If set to true, will cause all occurrences of ${ in the generated files to be replaced with x{. Link to this property field\_delimiter: optional string String to join fields. This field be ignored when record_template is set. Link to this property field\_names: optional array of string List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in. Link to this property merge\_subrequests: optional boolean If set to true, subrequests will be merged into the parent request. Only supported for the http_requests dataset. Not supported for account-scoped jobs. Link to this property
output\_type: optional "ndjson"or "csv" Specifies the output type, such as ndjson or csv. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types. One of the following: "ndjson" Link to this property "csv" Link to this property
Link to this property record\_delimiter: optional string String to be inserted in-between the records as separator. Link to this property record\_prefix: optional string String to be prepended before each record. Link to this property record\_suffix: optional string String to be appended after each record. Link to this property record\_template: optional string String to use as template for each record instead of the default json key value mapping. All fields used in the template must be present in field_names as well, otherwise they will end up as null. Format as a Go text/template without any standard functions, like conditionals, loops, sub-templates, etc. Link to this property sample\_rate: optional number Specifies the sampling rate as a floating number greater than 0 and at most 1. Sampling is applied on top of filtering, and regardless of the current sample_interval of the data. formatfloat exclusiveMinimum maximum1 minimum0 Link to this property
timestamp\_format: optional "unixnano"or "unix"or "rfc3339"or 2 more String to specify the format for timestamps, such as unixnano, unix, rfc3339, rfc3339ms or rfc3339ns. One of the following: "unixnano" Link to this property "unix" Link to this property "rfc3339" Link to this property "rfc3339ms" Link to this property "rfc3339ns" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### List Logpush jobs HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/$ACCOUNTS_OR_ZONES/$ACCOUNT_OR_ZONE_ID/logpush/jobs \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "id": 1, "dataset": "http_requests", "destination_conf": "s3://mybucket/logs?region=us-west-2", "enabled": false, "error_message": "error_message", "filter_attack_traffic": true, "frequency": "high", "kind": "", "last_complete": "2019-12-27T18:11:19.117Z", "last_error": "2019-12-27T18:11:19.117Z", "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339", "max_upload_bytes": 5000000, "max_upload_interval_seconds": 30, "max_upload_records": 1000, "name": "example.com", "output_options": { "batch_prefix": "batch_prefix", "batch_suffix": "batch_suffix", "CVE-2021-44228": true, "field_delimiter": "field_delimiter", "field_names": [ "ClientIP", "EdgeStartTimestamp", "RayID" ], "merge_subrequests": true, "output_type": "ndjson", "record_delimiter": "record_delimiter", "record_prefix": "record_prefix", "record_suffix": "record_suffix", "record_template": "record_template", "sample_rate": 1, "timestamp_format": "unixnano" } } ] } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "id": 1, "dataset": "http_requests", "destination_conf": "s3://mybucket/logs?region=us-west-2", "enabled": false, "error_message": "error_message", "filter_attack_traffic": true, "frequency": "high", "kind": "", "last_complete": "2019-12-27T18:11:19.117Z", "last_error": "2019-12-27T18:11:19.117Z", "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp×tamps=rfc3339", "max_upload_bytes": 5000000, "max_upload_interval_seconds": 30, "max_upload_records": 1000, "name": "example.com", "output_options": { "batch_prefix": "batch_prefix", "batch_suffix": "batch_suffix", "CVE-2021-44228": true, "field_delimiter": "field_delimiter", "field_names": [ "ClientIP", "EdgeStartTimestamp", "RayID" ], "merge_subrequests": true, "output_type": "ndjson", "record_delimiter": "record_delimiter", "record_prefix": "record_prefix", "record_suffix": "record_suffix", "record_template": "record_template", "sample_rate": 1, "timestamp_format": "unixnano" } } ] } ```