This API exposes
11 operations
across 8 paths,
and defines 29 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
11 operations8 paths29 schemas1 DELETE4 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Logpush Jobs for an Account API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 11
Across 8 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are logpush_logpush_job (15 properties), logpush_output_options (12 properties), logpush_api-response-common-failure (4 properties), logpush_api-response-common (3 properties). Each schema is shown below with its type and property counts.
logpush_logpush_job
object
15 properties
logpush_logpush_field_response_collection
logpush_messages
array
logpush_get_ownership_response
logpush_output_options
object
The structured replacement for logpulloptions. When including this field, the logpulloption field will be ignored.
12 properties
logpush_api-response-common-failure
object
4 properties4 required
logpush_validate_response
logpush_logpush_job_response_collection
logpush_destination_exists_response
logpush_validate_ownership_response
logpush_identifier
string
Identifier
logpush_api-response-common
object
3 properties3 required
logpush_logpush_job_response_single
logpush_max_upload_records
integer
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 nu…
logpush_ownership_challenge
string
Ownership challenge token to prove destination ownership.
logpush_id
integer
Unique id of the job.
logpush_name
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…
logpush_last_error
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…
logpush_frequency
string
This field is deprecated. Please use maxupload parameters instead. The frequency at which Cloudflare sends batches of logs to your destination. Setting frequen…
logpush_max_upload_bytes
integer
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…
logpush_api-response-single
object
logpush_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 includ…
logpush_kind
string
The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs. Currently, Edge Log Delivery is only supported for the httpr…
logpush_dataset
string
Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).
logpush_logpull_options
string
This field is deprecated. Use outputoptions instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from t…
logpush_error_message
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 r…
logpush_max_upload_interval_seconds
integer
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…
logpush_enabled
boolean
Flag that indicates if the job is enabled.
logpush_last_complete
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…
Specification
The full machine-readable OpenAPI contract behind this narrative.
