--- title: Update Logpush job --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Logpush](https://developers.cloudflare.com/api/go/resources/logpush) [Jobs](https://developers.cloudflare.com/api/go/resources/logpush/subresources/jobs) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update Logpush job client.Logpush.Jobs.Update(ctx, jobID, params) (\*[LogpushJob](), error) PUT/{accounts\_or\_zones}/{account\_or\_zone\_id}/logpush/jobs/{job\_id} Updates a Logpush job. ##### 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` ##### ParametersExpand Collapse jobID int64 Unique id of the job. minimum1 [Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20job_id%20%3E%20(schema)>)
params JobUpdateParams AccountID param.Field\[string]Optional Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property ZoneID param.Field\[string]Optional Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property DestinationConf param.Field\[string]Optional Body param: 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 param.Field\[bool]Optional Body param: Flag that indicates if the job is enabled. Link to this property Filter param.Field\[string]Optional Body param: The filters to select the events to include and/or remove from your logs. For more information, refer to Filters. Link to this property FilterAttackTraffic param.Field\[bool]Optional Body param: 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 param.Field\[JobUpdateParamsFrequency]Optional Body param: 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. const JobUpdateParamsFrequencyHigh JobUpdateParamsFrequency = "high" Link to this property const JobUpdateParamsFrequencyLow JobUpdateParamsFrequency = "low" Link to this property
Link to this property
Kind param.Field\[JobUpdateParamsKind]Optional Body param: The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset). const JobUpdateParamsKindEmpty JobUpdateParamsKind = "" Link to this property const JobUpdateParamsKindEdge JobUpdateParamsKind = "edge" Link to this property
Link to this property DeprecatedLogpullOptions param.Field\[string]Optional Body param: 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
MaxUploadBytes param.Field\[JobUpdateParamsMaxUploadBytes]Optional Body param: 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. type JobUpdateParamsMaxUploadBytes int64 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 int64 Link to this property
Link to this property
MaxUploadIntervalSeconds param.Field\[JobUpdateParamsMaxUploadIntervalSeconds]Optional Body param: 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. type JobUpdateParamsMaxUploadIntervalSeconds int64 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 int64 Link to this property
Link to this property
MaxUploadRecords param.Field\[JobUpdateParamsMaxUploadRecords]Optional Body param: 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. type JobUpdateParamsMaxUploadRecords int64 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 int64 Link to this property
Link to this property Name param.Field\[string]Optional Body param: 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 OutputOptions param.Field\[OutputOptions]Optional Body param: The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored. Link to this property OwnershipChallenge param.Field\[string]Optional Body param: Ownership challenge token to prove destination ownership. maxLength4096 Link to this property
[Link to this property](<#(resource)%20logpush.jobs%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type LogpushJob struct{…} ID int64Optional Unique id of the job. minimum1 Link to this property
Dataset LogpushJobDatasetOptional Name of the dataset. A list of supported datasets can be found on the Developer Docs. One of the following: const LogpushJobDatasetAccessRequests LogpushJobDataset = "access\_requests" Link to this property const LogpushJobDatasetAccountAbuseProtectionEvents LogpushJobDataset = "account\_abuse\_protection\_events" Link to this property const LogpushJobDatasetAuditLogs LogpushJobDataset = "audit\_logs" Link to this property const LogpushJobDatasetAuditLogsV2 LogpushJobDataset = "audit\_logs\_v2" Link to this property const LogpushJobDatasetBISOUserActions LogpushJobDataset = "biso\_user\_actions" Link to this property const LogpushJobDatasetCasbFindings LogpushJobDataset = "casb\_findings" Link to this property const LogpushJobDatasetDevicePostureResults LogpushJobDataset = "device\_posture\_results" Link to this property const LogpushJobDatasetDEXApplicationTests LogpushJobDataset = "dex\_application\_tests" Link to this property const LogpushJobDatasetDEXDeviceStateEvents LogpushJobDataset = "dex\_device\_state\_events" Link to this property const LogpushJobDatasetDLPForensicCopies LogpushJobDataset = "dlp\_forensic\_copies" Link to this property const LogpushJobDatasetDNSFirewallLogs LogpushJobDataset = "dns\_firewall\_logs" Link to this property const LogpushJobDatasetDNSLogs LogpushJobDataset = "dns\_logs" Link to this property const LogpushJobDatasetEmailSecurityAlerts LogpushJobDataset = "email\_security\_alerts" Link to this property const LogpushJobDatasetEmailSecurityPostDeliveryEvents LogpushJobDataset = "email\_security\_post\_delivery\_events" Link to this property const LogpushJobDatasetFirewallEvents LogpushJobDataset = "firewall\_events" Link to this property const LogpushJobDatasetGatewayDNS LogpushJobDataset = "gateway\_dns" Link to this property const LogpushJobDatasetGatewayHTTP LogpushJobDataset = "gateway\_http" Link to this property const LogpushJobDatasetGatewayNetwork LogpushJobDataset = "gateway\_network" Link to this property const LogpushJobDatasetHTTPRequests LogpushJobDataset = "http\_requests" Link to this property const LogpushJobDatasetIPSECLogs LogpushJobDataset = "ipsec\_logs" Link to this property const LogpushJobDatasetMagicBGPLogs LogpushJobDataset = "magic\_bgp\_logs" Link to this property const LogpushJobDatasetMagicIDsDetections LogpushJobDataset = "magic\_ids\_detections" Link to this property const LogpushJobDatasetMcpPortalLogs LogpushJobDataset = "mcp\_portal\_logs" Link to this property const LogpushJobDatasetMNMFlowLogs LogpushJobDataset = "mnm\_flow\_logs" Link to this property const LogpushJobDatasetNELReports LogpushJobDataset = "nel\_reports" Link to this property const LogpushJobDatasetNetworkAnalyticsLogs LogpushJobDataset = "network\_analytics\_logs" Link to this property const LogpushJobDatasetPageShieldEvents LogpushJobDataset = "page\_shield\_events" Link to this property const LogpushJobDatasetSinkholeHTTPLogs LogpushJobDataset = "sinkhole\_http\_logs" Link to this property const LogpushJobDatasetSpectrumEvents LogpushJobDataset = "spectrum\_events" Link to this property const LogpushJobDatasetSSHLogs LogpushJobDataset = "ssh\_logs" Link to this property const LogpushJobDatasetTurnstileEvents LogpushJobDataset = "turnstile\_events" Link to this property const LogpushJobDatasetWARPConfigChanges LogpushJobDataset = "warp\_config\_changes" Link to this property const LogpushJobDatasetWARPToggleChanges LogpushJobDataset = "warp\_toggle\_changes" Link to this property const LogpushJobDatasetWebsocketAnalytics LogpushJobDataset = "websocket\_analytics" Link to this property const LogpushJobDatasetWorkersTraceEvents LogpushJobDataset = "workers\_trace\_events" Link to this property const LogpushJobDatasetZarazEvents LogpushJobDataset = "zaraz\_events" Link to this property const LogpushJobDatasetZeroTrustNetworkSessions LogpushJobDataset = "zero\_trust\_network\_sessions" Link to this property
Link to this property DestinationConf stringOptional 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 boolOptional Flag that indicates if the job is enabled. Link to this property ErrorMessage stringOptional 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 FilterAttackTraffic boolOptional 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 LogpushJobFrequencyOptional 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: const LogpushJobFrequencyHigh LogpushJobFrequency = "high" Link to this property const LogpushJobFrequencyLow LogpushJobFrequency = "low" Link to this property
Link to this property
Kind LogpushJobKindOptional The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset). One of the following: const LogpushJobKindEmpty LogpushJobKind = "" Link to this property const LogpushJobKindEdge LogpushJobKind = "edge" Link to this property
Link to this property LastComplete TimeOptional 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 LastError TimeOptional 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 DeprecatedLogpullOptions stringOptional 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
MaxUploadBytes LogpushJobMaxUploadBytesOptional 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: type LogpushJobMaxUploadBytes int64 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 int64 Link to this property
Link to this property
MaxUploadIntervalSeconds LogpushJobMaxUploadIntervalSecondsOptional 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: type LogpushJobMaxUploadIntervalSeconds int64 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 int64 Link to this property
Link to this property
MaxUploadRecords LogpushJobMaxUploadRecordsOptional 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: type LogpushJobMaxUploadRecords int64 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 int64 Link to this property
Link to this property Name stringOptional 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
OutputOptions OutputOptionsOptional The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored. BatchPrefix stringOptional String to be prepended before each batch. Link to this property BatchSuffix stringOptional String to be appended after each batch. Link to this property Cve2021\_44228 boolOptional If set to true, will cause all occurrences of ${ in the generated files to be replaced with x{. Link to this property FieldDelimiter stringOptional String to join fields. This field be ignored when record_template is set. Link to this property FieldNames \[]stringOptional 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 MergeSubrequests boolOptional 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
OutputType OutputOptionsOutputTypeOptional 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: const OutputOptionsOutputTypeNdjson OutputOptionsOutputType = "ndjson" Link to this property const OutputOptionsOutputTypeCsv OutputOptionsOutputType = "csv" Link to this property
Link to this property RecordDelimiter stringOptional String to be inserted in-between the records as separator. Link to this property RecordPrefix stringOptional String to be prepended before each record. Link to this property RecordSuffix stringOptional String to be appended after each record. Link to this property RecordTemplate stringOptional 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 SampleRate float64Optional 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
TimestampFormat OutputOptionsTimestampFormatOptional String to specify the format for timestamps, such as unixnano, unix, rfc3339, rfc3339ms or rfc3339ns. One of the following: const OutputOptionsTimestampFormatUnixnano OutputOptionsTimestampFormat = "unixnano" Link to this property const OutputOptionsTimestampFormatUnix OutputOptionsTimestampFormat = "unix" Link to this property const OutputOptionsTimestampFormatRfc3339 OutputOptionsTimestampFormat = "rfc3339" Link to this property const OutputOptionsTimestampFormatRfc3339ms OutputOptionsTimestampFormat = "rfc3339ms" Link to this property const OutputOptionsTimestampFormatRfc3339ns OutputOptionsTimestampFormat = "rfc3339ns" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20logpush.jobs%20%3E%20(model)%20logpush_job%20%3E%20(schema)>) ### Update Logpush job Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/logpush" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) logpushJob, err := client.Logpush.Jobs.Update( context.TODO(), int64(1), logpush.JobUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", logpushJob.ID) } ``` 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" } } } ```