APIs.io Engineering Platform Radar Traffic Anomalies 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 Radar Traffic Anomalies API
  version: 4.0.0
tags:
- name: Radar Traffic Anomalies
paths:
  /radar/traffic_anomalies:
    get:
      description: "Internet traffic anomalies are signals that might point to an outage,\n        These alerts are automatically detected by Radar and then manually verified by our team.\n        This endpoint returns the latest alerts.\n        "
      operationId: radar-get-traffic-anomalies
      parameters:
      - description: Limit the number of objects in the response.
        in: query
        name: limit
        schema:
          description: Limit the number of objects in the response.
          example: 5
          type: integer
      - description: Number of objects to skip before grabbing results.
        in: query
        name: offset
        schema:
          description: Number of objects to skip before grabbing results.
          type: integer
      - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
        in: query
        name: dateRange
        schema:
          description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          example: 7d
          pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
          type: string
      - description: Start of the date range (inclusive).
        in: query
        name: dateStart
        schema:
          description: Start of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
          format: date-time
          type: string
      - description: End of the date range (inclusive).
        in: query
        name: dateEnd
        schema:
          description: End of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
          format: date-time
          type: string
      - in: query
        name: status
        schema:
          enum:
          - VERIFIED
          - UNVERIFIED
          type: string
      - description: Single ASN as integer.
        in: query
        name: asn
        schema:
          description: Single ASN as integer.
          example: '174'
          type: integer
      - description: Location Alpha2 code.
        in: query
        name: location
        schema:
          description: Location Alpha2 code.
          example: US
          type: string
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      trafficAnomalies:
                        items:
                          properties:
                            asnDetails:
                              properties:
                                asn:
                                  example: '189'
                                  type: string
                                locations:
                                  properties:
                                    code:
                                      example: US
                                      type: string
                                    name:
                                      example: United States
                                      type: string
                                  required:
                                  - code
                                  - name
                                  type: object
                                name:
                                  example: LUMEN-LEGACY-L3-PARTITION
                                  type: string
                              required:
                              - asn
                              - name
                              type: object
                            endDate:
                              example: '2023-08-03T23:15:00Z'
                              type: string
                            locationDetails:
                              properties:
                                code:
                                  example: US
                                  type: string
                                name:
                                  example: United States
                                  type: string
                              required:
                              - code
                              - name
                              type: object
                            startDate:
                              example: '2023-08-02T23:15:00Z'
                              type: string
                            status:
                              example: UNVERIFIED
                              type: string
                            type:
                              example: LOCATION
                              type: string
                            uuid:
                              example: 55a57f33-8bc0-4984-b4df-fdaff72df39d
                              type: string
                            visibleInDataSources:
                              items:
                                type: string
                              type: array
                          required:
                          - uuid
                          - type
                          - status
                          - startDate
                          type: object
                        type: array
                    required:
                    - trafficAnomalies
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: List of Internet traffic anomalies
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get latest Internet traffic anomalies.
      tags:
      - Radar Traffic Anomalies
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/traffic_anomalies/locations:
    get:
      description: "Internet traffic anomalies are signals that might point to an outage,\n        These alerts are automatically detected by Radar and then manually verified by our team.\n        This endpoint returns the sum of alerts grouped by location.\n        "
      operationId: radar-get-traffic-anomalies-top
      parameters:
      - description: Limit the number of objects in the response.
        in: query
        name: limit
        schema:
          description: Limit the number of objects in the response.
          example: 5
          type: integer
      - description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
        in: query
        name: dateRange
        schema:
          description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          example: 7d
          pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
          type: string
      - description: Start of the date range (inclusive).
        in: query
        name: dateStart
        schema:
          description: Start of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
          format: date-time
          type: string
      - description: End of the date range (inclusive).
        in: query
        name: dateEnd
        schema:
          description: End of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
          format: date-time
          type: string
      - in: query
        name: status
        schema:
          enum:
          - VERIFIED
          - UNVERIFIED
          type: string
      - description: Format results are returned in.
        in: query
        name: format
        schema:
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      trafficAnomalies:
                        items:
                          properties:
                            clientCountryAlpha2:
                              example: PT
                              type: string
                            clientCountryName:
                              example: Portugal
                              type: string
                            value:
                              example: '5'
                              type: string
                          required:
                          - clientCountryAlpha2
                          - clientCountryName
                          - value
                          type: object
                        type: array
                    required:
                    - trafficAnomalies
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: List of locations with number of traffic anomalies
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                    type: array
                  result:
                    type: object
                  success:
                    example: false
                    type: boolean
                required:
                - result
                - success
                - errors
                type: object
          description: Bad Request
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get top locations by total traffic anomalies generated.
      tags:
      - Radar Traffic Anomalies
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  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