APIs.io Engineering Platform Logpush Jobs for an Account API

The Logpush Jobs for an Account API from APIs.io Engineering Platform — 8 operation(s) for logpush jobs for an account.

Operations 11

GET /accounts/{account_id}/logpush/datasets/{dataset_id}/fields APIs.io Engineering Platform List fields #
GET /accounts/{account_id}/logpush/datasets/{dataset_id}/jobs APIs.io Engineering Platform List Logpush jobs for a dataset #
GET /accounts/{account_id}/logpush/jobs APIs.io Engineering Platform List Logpush jobs #
POST /accounts/{account_id}/logpush/jobs APIs.io Engineering Platform Create Logpush job #
DELETE /accounts/{account_id}/logpush/jobs/{job_id} APIs.io Engineering Platform Delete Logpush job #
GET /accounts/{account_id}/logpush/jobs/{job_id} APIs.io Engineering Platform Get Logpush job details #
PUT /accounts/{account_id}/logpush/jobs/{job_id} APIs.io Engineering Platform Update Logpush job #
POST /accounts/{account_id}/logpush/ownership APIs.io Engineering Platform Get ownership challenge #
POST /accounts/{account_id}/logpush/ownership/validate APIs.io Engineering Platform Validate ownership challenge #
POST /accounts/{account_id}/logpush/validate/destination/exists APIs.io Engineering Platform Check destination exists #
POST /accounts/{account_id}/logpush/validate/origin APIs.io Engineering Platform Validate origin #

Documentation

Specifications

Other Resources

🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1ab188a6-cc1f-490d-9413-9c6da20918d0?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-0e94f581-cbc1-48e0-b594-1f6b3d07a328?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4517d93a-e7f7-4dc2-b572-06762bbe14de?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-88f9ddbb-3115-47dc-b6e5-7fc6f1d2a190?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-3a12caae-4945-4df4-8ab9-bb6219ba7a9f?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-863b18f0-c2f2-4e32-a5fa-0d1e6ccf77a9?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-189876d1-f207-49a2-a4bc-5c67ae78cd19?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c1e74fd9-3f84-4d95-943d-d645d6cb82f7?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b002164d-6e8a-4b6d-b409-4929476e7818?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-508660fd-30b8-4c9c-aede-8edbac8a514d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-da35e0ba-f1a9-42fe-a77a-56ff0a47e341?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1d4df7d0-9c92-4fa8-946f-2110c2b3b48d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-2af6f54f-d259-46c0-8f86-78856f5885cd?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-cc203f31-e7f6-42ec-ad34-c5c4cde58904?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-f19285da-48dd-4691-bbdf-f7d6bec157a3?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa69cacc-4bbf-4724-a1d4-78cdad57fee8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-a5858f86-04d3-4e15-ae11-b42c7516688b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c2052341-766c-43c7-b1dc-ed4985e4606b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa777c90-8271-4809-8eac-3ec39a9a899c?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4d5957dc-df05-4216-a5fc-d46b3ba811d8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-28d97617-fdba-46a5-ac3e-40f3d2e0fa57?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-7429b451-d812-4abc-b497-b763372cf5c5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b0eafdd0-adaa-48a2-a855-6a31beb86d83?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-209f34ef-13c1-400c-bca8-fcddb304aff5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-fb2bbbb8-d4cc-48b1-a660-c8e158bfbbea?action=share&creator=35240

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/engineering-platform-logpush-jobs-for-an-account-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

engineering-platform-logpush-jobs-for-an-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Logpush Jobs for an Account API
  version: 4.0.0
tags:
- name: Logpush Jobs for an Account
paths:
  /accounts/{account_id}/logpush/datasets/{dataset_id}/fields:
    get:
      description: Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.
      operationId: get-accounts-account_id-logpush-datasets-dataset_id-fields
      parameters:
      - example: gateway_dns
        in: path
        name: dataset_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_dataset'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: List fields response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_field_response_collection'
          description: List fields response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List fields
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      - Logs Read
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/datasets/{dataset_id}/jobs:
    get:
      description: Lists Logpush jobs for an account for a dataset.
      operationId: get-accounts-account_id-logpush-datasets-dataset_id-jobs
      parameters:
      - example: gateway_dns
        in: path
        name: dataset_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_dataset'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: List Logpush jobs for a dataset response failure
        '200':
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                - dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message: null
                  id: 1
                  kind: ''
                  last_complete: null
                  last_error: null
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ''
                    batch_suffix: ''
                    field_delimiter: ','
                    field_names:
                    - Datetime
                    - DstIP
                    - SrcIP
                    output_type: ndjson
                    record_delimiter: ''
                    record_prefix: '{'
                    record_suffix: '}

                      '
                    record_template: ''
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_collection'
          description: List Logpush jobs for a dataset response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Logpush jobs for a dataset
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      - Logs Read
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/jobs:
    get:
      description: Lists Logpush jobs for an account.
      operationId: get-accounts-account_id-logpush-jobs
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: List Logpush jobs response failure
        '200':
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                - dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message: null
                  id: 1
                  kind: ''
                  last_complete: null
                  last_error: null
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ''
                    batch_suffix: ''
                    field_delimiter: ','
                    field_names:
                    - Datetime
                    - DstIP
                    - SrcIP
                    output_type: ndjson
                    record_delimiter: ''
                    record_prefix: '{'
                    record_suffix: '}

                      '
                    record_template: ''
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_collection'
          description: List Logpush jobs response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Logpush jobs
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      - Logs Read
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Logpush job for an account.
      operationId: post-accounts-account_id-logpush-jobs
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            example:
              dataset: gateway_dns
              destination_conf: s3://mybucket/logs?region=us-west-2
              enabled: false
              kind: ''
              max_upload_bytes: 5e+06
              max_upload_interval_seconds: 30
              max_upload_records: 1000
              name: example.com
              output_options:
                CVE-2021-4428: false
                batch_prefix: ''
                batch_suffix: ''
                field_delimiter: ','
                field_names:
                - Datetime
                - DstIP
                - SrcIP
                output_type: ndjson
                record_delimiter: ''
                record_prefix: '{'
                record_suffix: '}

                  '
                record_template: ''
                sample_rate: 1
                timestamp_format: unixnano
              ownership_challenge": '00000000000000000000'
            schema:
              properties:
                dataset:
                  $ref: '#/components/schemas/logpush_dataset'
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                enabled:
                  $ref: '#/components/schemas/logpush_enabled'
                frequency:
                  $ref: '#/components/schemas/logpush_frequency'
                kind:
                  $ref: '#/components/schemas/logpush_kind'
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
                max_upload_bytes:
                  $ref: '#/components/schemas/logpush_max_upload_bytes'
                max_upload_interval_seconds:
                  $ref: '#/components/schemas/logpush_max_upload_interval_seconds'
                max_upload_records:
                  $ref: '#/components/schemas/logpush_max_upload_records'
                name:
                  $ref: '#/components/schemas/logpush_name'
                output_options:
                  $ref: '#/components/schemas/logpush_output_options'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
              required:
              - destination_conf
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Create Logpush job response failure
        '200':
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message: null
                  id: 1
                  kind: ''
                  last_complete: null
                  last_error: null
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ''
                    batch_suffix: ''
                    field_delimiter: ','
                    field_names:
                    - Datetime
                    - DstIP
                    - SrcIP
                    output_type: ndjson
                    record_delimiter: ''
                    record_prefix: '{'
                    record_suffix: '}

                      '
                    record_template: ''
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
          description: Create Logpush job response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create Logpush job
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/jobs/{job_id}:
    delete:
      description: Deletes a Logpush job.
      operationId: delete-accounts-account_id-logpush-jobs-job_id
      parameters:
      - in: path
        name: job_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Delete Logpush job response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common'
                - properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/logpush_id'
                      type: object
          description: Delete Logpush job response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete Logpush job
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Gets the details of a Logpush job.
      operationId: get-accounts-account_id-logpush-jobs-job_id
      parameters:
      - in: path
        name: job_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Get Logpush job details response failure
        '200':
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message: null
                  id: 1
                  kind: ''
                  last_complete: null
                  last_error: null
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ''
                    batch_suffix: ''
                    field_delimiter: ','
                    field_names:
                    - Datetime
                    - DstIP
                    - SrcIP
                    output_type: ndjson
                    record_delimiter: ''
                    record_prefix: '{'
                    record_suffix: '}

                      '
                    record_template: ''
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
          description: Get Logpush job details response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get Logpush job details
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      - Logs Read
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates a Logpush job.
      operationId: put-accounts-account_id-logpush-jobs-job_id
      parameters:
      - in: path
        name: job_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            example:
              destination_conf: s3://mybucket/logs?region=us-west-2
              enabled: false
              kind: ''
              max_upload_bytes: 5e+06
              max_upload_interval_seconds: 30
              max_upload_records: 1000
              output_options:
                CVE-2021-4428: false
                batch_prefix: ''
                batch_suffix: ''
                field_delimiter: ','
                field_names:
                - Datetime
                - DstIP
                - SrcIP
                output_type: ndjson
                record_delimiter: ''
                record_prefix: '{'
                record_suffix: '}

                  '
                record_template: ''
                sample_rate: 1
                timestamp_format: unixnano
              ownership_challenge": '00000000000000000000'
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                enabled:
                  $ref: '#/components/schemas/logpush_enabled'
                frequency:
                  $ref: '#/components/schemas/logpush_frequency'
                kind:
                  $ref: '#/components/schemas/logpush_kind'
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
                max_upload_bytes:
                  $ref: '#/components/schemas/logpush_max_upload_bytes'
                max_upload_interval_seconds:
                  $ref: '#/components/schemas/logpush_max_upload_interval_seconds'
                max_upload_records:
                  $ref: '#/components/schemas/logpush_max_upload_records'
                output_options:
                  $ref: '#/components/schemas/logpush_output_options'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Update Logpush job response failure
        '200':
          content:
            application/json:
              example:
                errors: []
                messages: []
                result:
                  dataset: gateway_dns
                  destination_conf: s3://mybucket/logs?region=us-west-2
                  enabled: false
                  error_message: null
                  id: 1
                  kind: ''
                  last_complete: null
                  last_error: null
                  max_upload_bytes: 5e+06
                  max_upload_interval_seconds: 30
                  max_upload_records: 1000
                  name: example.com
                  output_options:
                    CVE-2021-4428: false
                    batch_prefix: ''
                    batch_suffix: ''
                    field_delimiter: ','
                    field_names:
                    - Datetime
                    - DstIP
                    - SrcIP
                    output_type: ndjson
                    record_delimiter: ''
                    record_prefix: '{'
                    record_suffix: '}

                      '
                    record_template: ''
                    sample_rate: 1
                    timestamp_format: unixnano
                success: true
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
          description: Update Logpush job response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update Logpush job
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/ownership:
    post:
      description: Gets a new ownership challenge sent to your destination.
      operationId: post-accounts-account_id-logpush-ownership
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
              required:
              - destination_conf
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Get ownership challenge response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_get_ownership_response'
          description: Get ownership challenge response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get ownership challenge
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/ownership/validate:
    post:
      description: Validates ownership challenge of the destination.
      operationId: post-accounts-account_id-logpush-ownership-validate
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
              required:
              - destination_conf
              - ownership_challenge
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Validate ownership challenge response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_validate_ownership_response'
          description: Validate ownership challenge response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Validate ownership challenge
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/validate/destination/exists:
    post:
      description: Checks if there is an existing job with a destination.
      operationId: delete-accounts-account_id-logpush-validate-destination-exists
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
              required:
              - destination_conf
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Check destination exists response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_destination_exists_response'
          description: Check destination exists response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Check destination exists
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/logpush/validate/origin:
    post:
      description: Validates logpull origin with logpull_options.
      operationId: post-accounts-account_id-logpush-validate-origin
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
              required:
              - logpull_options
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
          description: Validate origin response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_validate_response'
          description: Validate origin response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Validate origin
      tags:
      - Logpush Jobs for an Account
      x-api-token-group:
      - Logs Write
      x-cfPermissionsRequired:
        enum:
        - '#logs:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    logpush_max_upload_interval_seconds:
      default: 30
      description: 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. This parameter is only used for jobs with `edge` as its kind.
      example: 30
      maximum: 300
      minimum: 30
      type:
      - integer
      - 'null'
    logpush_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/logpush_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/logpush_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    logpush_destination_conf:
      description: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
      example: s3://mybucket/logs?region=us-west-2
      format: uri
      maxLength: 4096
      type: string
    logpush_validate_ownership_response:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            properties:
              valid:
                example: true
                type: boolean
            type:
            - object
            - 'null'
    logpush_last_complete:
      description: 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.
      format: date-time
      type:
      - string
      - 'null'
    logpush_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    logpush_enabled:
      description: Flag that indicates if the job is enabled.
      example: false
      type: boolean
    logpush_logpush_job_response_single:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/logpush_logpush_job'
    logpush_output_options:
      description: The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.
      properties:
        CVE-2021-4428:
          default: false
          description: If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.
          type:
          - boolean
          - 'null'
        batch_prefix:
          default: ''
          description: String to be prepended before each batch.
          type:
          - string
          - 'null'
        batch_suffix:
          default: ''
          description: String to be appended after each batch.
          type:
          - string
          - 'null'
        field_delimiter:
          default: ','
          description: String to join fields. This field be ignored when `record_template` is set.
          type:
          - string
          - 'null'
        field_names:
          description: 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.
          example:
          - ClientIP
          - EdgeStartTimestamp
          - RayID
          items:
            type: string
          type: array
        output_type:
          default: ndjson
          description: 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.
          enum:
          - ndjson
          - csv
          example: ndjson
          type: string
        record_delimiter:
          default: ''
          description: String to be inserted in-between the records as separator.
          type:
          - string
          - 'null'
        record_prefix:
          default:

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-logpush-jobs-for-an-account-api-openapi.yml