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.

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

OpenAPI Specification

engineering-platform-logpush-jobs-for-an-account-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Logpush Jobs for an Account API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
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_logpush_job:
      nullable: true
      properties:
        dataset:
          $ref: '#/components/schemas/logpush_dataset'
        destination_conf:
          $ref: '#/components/schemas/logpush_destination_conf'
        enabled:
          $ref: '#/components/schemas/logpush_enabled'
        error_message:
          $ref: '#/components/schemas/logpush_error_message'
        frequency:
          $ref: '#/components/schemas/logpush_frequency'
        id:
          $ref: '#/components/schemas/logpush_id'
        kind:
          $ref: '#/components/schemas/logpush_kind'
        last_complete:
          $ref: '#/components/schemas/logpush_last_complete'
        last_error:
          $ref: '#/components/schemas/logpush_last_error'
        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'
      type: object
    logpush_logpush_field_response_collection:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            items:
              nullable: true
              properties:
                key:
                  example: value
                  type: string
              type: object
            type: object
    logpush_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    logpush_get_ownership_response:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            nullable: true
            properties:
              filename:
                example: logs/challenge-filename.txt
                type: string
              message:
                example: ''
                type: string
              valid:
                example: true
                type: boolean
            type: object
    logpush_output_options:
      description: The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.
      nulla

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