APIs.io Engineering Platform Botnet Threat Feed API

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 Botnet Threat Feed API
  version: 4.0.0
tags:
- name: Botnet Threat Feed
paths:
  /accounts/{account_id}/botnet_feed/asn/{asn_id}/day_report:
    get:
      description: Gets all the data the botnet tracking database has for a given ASN registered to user account for given date. If no date is given, it will return results for the previous day.
      operationId: botnet-threat-feed-get-day-report
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dos_identifier'
      - in: path
        name: asn_id
        required: true
        schema:
          $ref: '#/components/schemas/dos_asn'
      - in: query
        name: date
        schema:
          $ref: '#/components/schemas/dos_timestamp'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Get botnet feed report for day response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dos_api-response-common'
                - properties:
                    result:
                      properties:
                        cidr:
                          example: 1.1.1.1/32
                          type: string
                        date:
                          example: '2014-01-01T05:20:00.12345Z'
                          format: date-time
                          type: string
                        offense_count:
                          example: 1000
                          type: integer
                      type: object
                  type: object
                type: object
          description: Get botnet feed report for day
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get daily report
      tags:
      - Botnet Threat Feed
      x-api-token-group:
      - DDoS Botnet Feed Write
      - DDoS Botnet Feed Read
  /accounts/{account_id}/botnet_feed/asn/{asn_id}/full_report:
    get:
      description: Gets all the data the botnet threat feed tracking database has for a given ASN registered to user account.
      operationId: botnet-threat-feed-get-full-report
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dos_identifier'
      - in: path
        name: asn_id
        required: true
        schema:
          $ref: '#/components/schemas/dos_asn'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Get full botnet feed report response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dos_api-response-common'
                - properties:
                    result:
                      properties:
                        cidr:
                          example: 1.1.1.1/32
                          type: string
                        date:
                          example: '2014-01-01T05:20:00.12345Z'
                          format: date-time
                          type: string
                        offense_count:
                          example: 1000
                          type: integer
                      type: object
                  type: object
                type: object
          description: Get full botnet feed report
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get full report
      tags:
      - Botnet Threat Feed
      x-api-token-group:
      - DDoS Botnet Feed Write
      - DDoS Botnet Feed Read
  /accounts/{account_id}/botnet_feed/configs/asn:
    get:
      description: Gets a list of all ASNs registered for a user for the DDoS Botnet Feed API.
      operationId: botnet-threat-feed-list-asn
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dos_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Get list of ASNs response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dos_api-response-common'
                - properties:
                    result:
                      properties:
                        asn:
                          example: 13335
                          type: integer
                      type: object
                  type: object
                type: object
          description: Get list of ASNs response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get list of ASNs
      tags:
      - Botnet Threat Feed
      x-api-token-group:
      - DDoS Botnet Feed Write
      - DDoS Botnet Feed Read
  /accounts/{account_id}/botnet_feed/configs/asn/{asn_id}:
    delete:
      description: Delete an ASN from botnet threat feed for a given user.
      operationId: botnet-threat-feed-delete-asn
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dos_identifier'
      - in: path
        name: asn_id
        required: true
        schema:
          $ref: '#/components/schemas/dos_asn'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dos_api-response-common-failure'
          description: Delete ASN response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dos_api-response-common'
                - properties:
                    result:
                      properties:
                        asn:
                          example: 13335
                          type: integer
                      type: object
                  type: object
                type: object
          description: Delete ASN response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete an ASN
      tags:
      - Botnet Threat Feed
      x-api-token-group:
      - DDoS Botnet Feed Write
components:
  schemas:
    dos_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    dos_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dos_messages'
        messages:
          $ref: '#/components/schemas/dos_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    dos_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dos_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dos_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dos_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
    dos_asn:
      type: integer
    dos_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey