--- title: Logpush --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Logpush #### LogpushDatasets #### LogpushDatasetsFields ##### [List fields](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/datasets/subresources/fields/methods/get) client.logpush.datasets.fields.get("access\_requests"| "account\_abuse\_protection\_events"| "audit\_logs"| 34 moredatasetID, FieldGetParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [FieldGetResponse]() GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/datasets/{dataset\_id}/fields ##### ModelsExpand Collapse FieldGetResponse = Record [Link to this property](<#(resource)%20logpush.datasets.fields%20%3E%20(model)%20field_get_response%20%3E%20(schema)>) #### LogpushDatasetsJobs ##### [List Logpush jobs for a dataset](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/datasets/subresources/jobs/methods/get) client.logpush.datasets.jobs.get("access\_requests"| "account\_abuse\_protection\_events"| "audit\_logs"| 34 moredatasetID, JobGetParams {account\_id, zone\_id } params?, RequestOptionsoptions?): SinglePage< [LogpushJob]() {id, dataset, destination\_conf, 13 more } | null> GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/datasets/{dataset\_id}/jobs #### LogpushEdge ##### [List Instant Logs jobs](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/edge/methods/get) client.logpush.edge.get(EdgeGetParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [InstantLogpushJob]() {destination\_conf, fields, filter, 2 more } | null> GET/zones/{zone\_id}/logpush/edge/jobs ##### [Create Instant Logs job](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/edge/methods/create) client.logpush.edge.create(EdgeCreateParams {zone\_id, fields, filter, sample } params, RequestOptionsoptions?): [InstantLogpushJob]() {destination\_conf, fields, filter, 2 more } | null POST/zones/{zone\_id}/logpush/edge/jobs ##### ModelsExpand Collapse

InstantLogpushJob {destination\_conf, fields, filter, 2 more }

destination\_conf?: string Unique WebSocket address that will receive messages from Cloudflare’s edge. formaturi maxLength4096 Link to this property fields?: string Comma-separated list of fields. Link to this property filter?: string Filters to drill down into specific events. Link to this property sample?: number The sample parameter is the sample rate of the records set by the client: “sample”: 1 is 100% of records “sample”: 10 is 10% and so on. Link to this property session\_id?: string Unique session id of the job. Link to this property

[Link to this property](<#(resource)%20logpush.edge%20%3E%20(model)%20instant_logpush_job%20%3E%20(schema)>) #### LogpushJobs ##### [List Logpush jobs](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/jobs/methods/list) client.logpush.jobs.list(JobListParams {account\_id, zone\_id } params?, RequestOptionsoptions?): SinglePage< [LogpushJob]() {id, dataset, destination\_conf, 13 more } | null> GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/jobs ##### [Get Logpush job details](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/jobs/methods/get) client.logpush.jobs.get(numberjobID, JobGetParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [LogpushJob]() {id, dataset, destination\_conf, 13 more } | null GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/jobs/{job\_id} ##### [Create Logpush job](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/jobs/methods/create) client.logpush.jobs.create(JobCreateParams {destination\_conf, account\_id, zone\_id, 13 more } params, RequestOptionsoptions?): [LogpushJob]() {id, dataset, destination\_conf, 13 more } | null POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/jobs ##### [Update Logpush job](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/jobs/methods/update) client.logpush.jobs.update(numberjobID, JobUpdateParams {account\_id, zone\_id, destination\_conf, 12 more } params, RequestOptionsoptions?): [LogpushJob]() {id, dataset, destination\_conf, 13 more } | null PUT/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/jobs/{job\_id} ##### [Delete Logpush job](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/jobs/methods/delete) client.logpush.jobs.delete(numberjobID, JobDeleteParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [JobDeleteResponse]() {id } DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/jobs/{job\_id} ##### ModelsExpand Collapse

LogpushJob {id, dataset, destination\_conf, 13 more }

id?: number Unique id of the job. minimum1 Link to this property

dataset?: "access\_requests"| "account\_abuse\_protection\_events"| "audit\_logs"| 34 more| null 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?: 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?: boolean Flag that indicates if the job is enabled. Link to this property error\_message?: string| null 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?: 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?: "high"| "low"| null 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?: ""| "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?: string| null 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?: string| null 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?: string| null 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?: 0| number| null 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 Link to this property

Link to this property number Link to this property

Link to this property

max\_upload\_interval\_seconds?: 0| number| null 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 Link to this property

Link to this property number Link to this property

Link to this property

max\_upload\_records?: 0| number| null 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 Link to this property

Link to this property number Link to this property

Link to this property name?: string| null 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?: OutputOptions {batch\_prefix, batch\_suffix, CVE-2021-44228, 10 more } | null The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored. Link to this property

[Link to this property](<#(resource)%20logpush.jobs%20%3E%20(model)%20logpush_job%20%3E%20(schema)>)

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?: string| null String to be prepended before each batch. Link to this property batch\_suffix?: string| null String to be appended after each batch. Link to this property "CVE-2021-44228"?: boolean| null If set to true, will cause all occurrences of ${ in the generated files to be replaced with x{. Link to this property field\_delimiter?: string| null String to join fields. This field be ignored when record_template is set. Link to this property field\_names?: Array<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?: boolean| null 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?: "ndjson"| "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?: string| null String to be inserted in-between the records as separator. Link to this property record\_prefix?: string| null String to be prepended before each record. Link to this property record\_suffix?: string| null String to be appended after each record. Link to this property record\_template?: string| null 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?: number| null 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?: "unixnano"| "unix"| "rfc3339"| 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](<#(resource)%20logpush.jobs%20%3E%20(model)%20output_options%20%3E%20(schema)>)

JobDeleteResponse {id }

id?: number Unique id of the job. minimum1 Link to this property

[Link to this property](<#(resource)%20logpush.jobs%20%3E%20(model)%20job_delete_response%20%3E%20(schema)>) #### LogpushOwnership ##### [Get ownership challenge](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/ownership/methods/create) client.logpush.ownership.create(OwnershipCreateParams {destination\_conf, account\_id, zone\_id } params, RequestOptionsoptions?): [OwnershipCreateResponse]() {filename, message, valid } | null POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/ownership ##### [Validate ownership challenge](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/ownership/methods/validate) client.logpush.ownership.validate(OwnershipValidateParams {destination\_conf, ownership\_challenge, account\_id, zone\_id } params, RequestOptionsoptions?): [OwnershipValidation]() {valid } | null POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/ownership/validate ##### ModelsExpand Collapse

OwnershipValidation {valid }

valid?: boolean Link to this property

[Link to this property](<#(resource)%20logpush.ownership%20%3E%20(model)%20ownership_validation%20%3E%20(schema)>)

OwnershipCreateResponse {filename, message, valid }

filename?: string Link to this property message?: string Link to this property valid?: boolean Link to this property

[Link to this property](<#(resource)%20logpush.ownership%20%3E%20(model)%20ownership_create_response%20%3E%20(schema)>) #### LogpushTransformers ##### [List transformers](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/methods/list) client.logpush.transformers.list(TransformerListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [TransformerListResponse]() {id, associated\_jobs, created\_at, 4 more } > GET/accounts/{account\_id}/logpush/transformers ##### [Get transformer](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/methods/get) client.logpush.transformers.get(numbertransformerID, TransformerGetParams {account\_id } params, RequestOptionsoptions?): [TransformerGetResponse]() {id, associated\_jobs, created\_at, 4 more } GET/accounts/{account\_id}/logpush/transformers/{transformer\_id} ##### [Create transformer](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/methods/create) client.logpush.transformers.create(TransformerCreateParams {account\_id, code, name, description } params, RequestOptionsoptions?): [TransformerCreateResponse]() {id, associated\_jobs, created\_at, 4 more } POST/accounts/{account\_id}/logpush/transformers ##### [Update transformer](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/methods/update) client.logpush.transformers.update(numbertransformerID, TransformerUpdateParams {account\_id, name, code, description } params, RequestOptionsoptions?): [TransformerUpdateResponse]() {id, associated\_jobs, created\_at, 4 more } PUT/accounts/{account\_id}/logpush/transformers/{transformer\_id} ##### [Delete transformer](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/methods/delete) client.logpush.transformers.delete(numbertransformerID, TransformerDeleteParams {account\_id } params, RequestOptionsoptions?): [TransformerDeleteResponse]() {id } DELETE/accounts/{account\_id}/logpush/transformers/{transformer\_id} ##### [Preview transformer](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/methods/preview) client.logpush.transformers.preview(TransformerPreviewParams {account\_id, input, sql } params, RequestOptionsoptions?): SinglePage< [TransformerPreviewResponse]()> POST/accounts/{account\_id}/logpush/transformers/preview ##### ModelsExpand Collapse

TransformerListResponse {id, associated\_jobs, created\_at, 4 more }

id?: number The transformer ID. minimum1 Link to this property

associated\_jobs?: Array<AssociatedJob> Logpush jobs that reference this transformer.

id?: number The logpush job ID. Link to this property name?: string The logpush job destination name. Link to this property object\_tag?: string The zone or account tag. Link to this property

object\_type?: "zone"| "account" Whether the job is zone-scoped or account-scoped.

One of the following: "zone" Link to this property "account" Link to this property

Link to this property

Link to this property created\_at?: string When the transformer was created (RFC 3339). formatdate-time Link to this property dataset?: string| null The dataset this transformer operates on, derived from the SQL query’s FROM clause. Informational only. May be absent if the dataset cannot be determined from the query. Link to this property description?: string Optional customer-provided description. maxLength4096 Link to this property name?: string Customer-provided name for identification. maxLength255 Link to this property updated\_at?: string When the transformer was last modified (RFC 3339). formatdate-time Link to this property

[Link to this property](<#(resource)%20logpush.transformers%20%3E%20(model)%20transformer_list_response%20%3E%20(schema)>)

TransformerGetResponse {id, associated\_jobs, created\_at, 4 more }

id?: number The transformer ID. minimum1 Link to this property

associated\_jobs?: Array<AssociatedJob> Logpush jobs that reference this transformer.

id?: number The logpush job ID. Link to this property name?: string The logpush job destination name. Link to this property object\_tag?: string The zone or account tag. Link to this property

object\_type?: "zone"| "account" Whether the job is zone-scoped or account-scoped.

One of the following: "zone" Link to this property "account" Link to this property

Link to this property

[Link to this property](<#(resource)%20logpush.transformers%20%3E%20(model)%20transformer_get_response%20%3E%20(schema)>)

TransformerCreateResponse {id, associated\_jobs, created\_at, 4 more }

id?: number The transformer ID. minimum1 Link to this property

associated\_jobs?: Array<AssociatedJob> Logpush jobs that reference this transformer.

id?: number The logpush job ID. Link to this property name?: string The logpush job destination name. Link to this property object\_tag?: string The zone or account tag. Link to this property

object\_type?: "zone"| "account" Whether the job is zone-scoped or account-scoped.

One of the following: "zone" Link to this property "account" Link to this property

Link to this property

[Link to this property](<#(resource)%20logpush.transformers%20%3E%20(model)%20transformer_create_response%20%3E%20(schema)>)

TransformerUpdateResponse {id, associated\_jobs, created\_at, 4 more }

id?: number The transformer ID. minimum1 Link to this property

associated\_jobs?: Array<AssociatedJob> Logpush jobs that reference this transformer.

id?: number The logpush job ID. Link to this property name?: string The logpush job destination name. Link to this property object\_tag?: string The zone or account tag. Link to this property

object\_type?: "zone"| "account" Whether the job is zone-scoped or account-scoped.

One of the following: "zone" Link to this property "account" Link to this property

Link to this property

[Link to this property](<#(resource)%20logpush.transformers%20%3E%20(model)%20transformer_update_response%20%3E%20(schema)>)

TransformerDeleteResponse {id }

id?: number The deleted transformer’s ID. Link to this property

[Link to this property](<#(resource)%20logpush.transformers%20%3E%20(model)%20transformer_delete_response%20%3E%20(schema)>) TransformerPreviewResponse = Record [Link to this property](<#(resource)%20logpush.transformers%20%3E%20(model)%20transformer_preview_response%20%3E%20(schema)>) #### LogpushTransformersContent ##### [Get transformer content](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/subresources/content/methods/get) client.logpush.transformers.content.get(numbertransformerID, ContentGetParams {account\_id, version\_id } params, RequestOptionsoptions?): [ContentGetResponse]() {content } GET/accounts/{account\_id}/logpush/transformers/{transformer\_id}/content ##### ModelsExpand Collapse

ContentGetResponse {content }

content?: string The SQL query content. Link to this property

[Link to this property](<#(resource)%20logpush.transformers.content%20%3E%20(model)%20content_get_response%20%3E%20(schema)>) #### LogpushTransformersVersions ##### [List transformer versions](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/transformers/subresources/versions/methods/list) client.logpush.transformers.versions.list(numbertransformerID, VersionListParams {account\_id, limit } params, RequestOptionsoptions?): SinglePage< [VersionListResponse]() {id, created\_at, version } > GET/accounts/{account\_id}/logpush/transformers/{transformer\_id}/versions ##### ModelsExpand Collapse

VersionListResponse {id, created\_at, version }

id?: number Unique identifier for this version. formatint64 minimum1 Link to this property created\_at?: string When this version was created (RFC 3339). formatdate-time Link to this property version?: number Sequential version number. minimum1 Link to this property

[Link to this property](<#(resource)%20logpush.transformers.versions%20%3E%20(model)%20version_list_response%20%3E%20(schema)>) #### LogpushValidate ##### [Validate destination](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/validate/methods/destination) client.logpush.validate.destination(ValidateDestinationParams {destination\_conf, account\_id, zone\_id } params, RequestOptionsoptions?): [ValidateDestinationResponse]() {message, valid } | null POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/validate/destination ##### [Check destination exists](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/validate/methods/destination_exists) client.logpush.validate.destinationExists(ValidateDestinationExistsParams {destination\_conf, account\_id, zone\_id } params, RequestOptionsoptions?): [ValidateDestinationExistsResponse]() {exists } | null POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/validate/destination/exists ##### [Validate origin](https://developers.cloudflare.com/api/typescript/resources/logpush/subresources/validate/methods/origin) client.logpush.validate.origin(ValidateOriginParams {logpull\_options, account\_id, zone\_id } params, RequestOptionsoptions?): [ValidateOriginResponse]() {message, valid } | null POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/validate/origin ##### ModelsExpand Collapse

ValidateDestinationResponse {message, valid }

message?: string Link to this property valid?: boolean Link to this property

[Link to this property](<#(resource)%20logpush.validate%20%3E%20(model)%20validate_destination_response%20%3E%20(schema)>)

ValidateDestinationExistsResponse {exists }

exists?: boolean Link to this property

[Link to this property](<#(resource)%20logpush.validate%20%3E%20(model)%20validate_destination_exists_response%20%3E%20(schema)>)

ValidateOriginResponse {message, valid }

message?: string Link to this property valid?: boolean Link to this property

[Link to this property](<#(resource)%20logpush.validate%20%3E%20(model)%20validate_origin_response%20%3E%20(schema)>)