APIs.io Engineering Platform Radar BGP API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Radar BGP 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: Radar BGP
paths:
  /radar/bgp/hijacks/events:
    get:
      description: Get the BGP hijack events. (Beta)
      operationId: radar-get-bgp-hijacks-events
      parameters:
      - description: Current page number, starting from 1
        in: query
        name: page
        schema:
          description: Current page number, starting from 1
          type: integer
      - description: Number of entries per page
        in: query
        name: per_page
        schema:
          description: Number of entries per page
          type: integer
      - description: The unique identifier of a event
        in: query
        name: eventId
        schema:
          description: The unique identifier of a event
          type: integer
      - description: The potential hijacker AS of a BGP hijack event
        in: query
        name: hijackerAsn
        schema:
          description: The potential hijacker AS of a BGP hijack event
          type: integer
      - description: The potential victim AS of a BGP hijack event
        in: query
        name: victimAsn
        schema:
          description: The potential victim AS of a BGP hijack event
          type: integer
      - description: The potential hijacker or victim AS of a BGP hijack event
        in: query
        name: involvedAsn
        schema:
          description: The potential hijacker or victim AS of a BGP hijack event
          type: integer
      - description: The country code of the potential hijacker or victim AS of a BGP hijack event
        in: query
        name: involvedCountry
        schema:
          description: The country code of the potential hijacker or victim AS of a BGP hijack event
          type: string
      - description: Network prefix, IPv4 or IPv6.
        in: query
        name: prefix
        schema:
          description: Network prefix, IPv4 or IPv6.
          example: 1.1.1.0/24
          type: string
      - description: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
        in: query
        name: minConfidence
        schema:
          description: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
          type: integer
      - description: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
        in: query
        name: maxConfidence
        schema:
          description: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
          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
      - description: Sort events by field
        in: query
        name: sortBy
        schema:
          description: Sort events by field
          enum:
          - ID
          - TIME
          - CONFIDENCE
          example: TIME
          type: string
      - description: Sort order
        in: query
        name: sortOrder
        schema:
          description: Sort order
          enum:
          - ASC
          - DESC
          example: DESC
          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:
                      asn_info:
                        items:
                          properties:
                            asn:
                              type: integer
                            country_code:
                              type: string
                            org_name:
                              type: string
                          required:
                          - asn
                          - org_name
                          - country_code
                          type: object
                        type: array
                      events:
                        items:
                          properties:
                            confidence_score:
                              type: integer
                            duration:
                              type: integer
                            event_type:
                              type: integer
                            hijack_msgs_count:
                              type: integer
                            hijacker_asn:
                              type: integer
                            hijacker_country:
                              type: string
                            id:
                              type: integer
                            is_stale:
                              type: boolean
                            max_hijack_ts:
                              type: string
                            max_msg_ts:
                              type: string
                            min_hijack_ts:
                              type: string
                            on_going_count:
                              type: integer
                            peer_asns:
                              items:
                                type: integer
                              type: array
                            peer_ip_count:
                              type: integer
                            prefixes:
                              items:
                                type: string
                              type: array
                            tags:
                              items:
                                properties:
                                  name:
                                    type: string
                                  score:
                                    type: integer
                                required:
                                - name
                                - score
                                type: object
                              type: array
                            victim_asns:
                              items:
                                type: integer
                              type: array
                            victim_countries:
                              items:
                                type: string
                              type: array
                          required:
                          - duration
                          - event_type
                          - hijack_msgs_count
                          - hijacker_asn
                          - hijacker_country
                          - victim_asns
                          - victim_countries
                          - id
                          - is_stale
                          - max_hijack_ts
                          - min_hijack_ts
                          - max_msg_ts
                          - on_going_count
                          - peer_asns
                          - peer_ip_count
                          - prefixes
                          - confidence_score
                          - tags
                          type: object
                        type: array
                      total_monitors:
                        type: integer
                    required:
                    - asn_info
                    - events
                    - total_monitors
                    type: object
                  result_info:
                    properties:
                      count:
                        type: integer
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                    required:
                    - count
                    - total_count
                    - page
                    - per_page
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - result_info
                - success
                type: object
          description: Successful Response
        '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 BGP hijack events
      tags:
      - Radar BGP
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/ips/timeseries:
    get:
      description: Gets time-series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN.
      operationId: radar-get-bgp-ips-timeseries
      parameters:
      - description: Array of names that will be used to name the series in responses.
        in: query
        name: name
        schema:
          description: Array of names that will be used to name the series in responses.
          example: main_series
          items:
            type: string
          type: array
      - description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
        in: query
        name: dateRange
        schema:
          description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
          example: 7d
          items:
            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
          type: array
      - description: Array of datetimes to filter the start of a series.
        in: query
        name: dateStart
        schema:
          description: Array of datetimes to filter the start of a series.
          example: '2023-09-01T11:41:33.782Z'
          items:
            format: date-time
            type: string
          type: array
      - 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'
          items:
            format: date-time
            type: string
          type: array
      - description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
        in: query
        name: asn
        schema:
          description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
          example: '15169'
          items:
            type: string
          type: array
      - description: Array of locations (alpha-2 country codes).
        in: query
        name: location
        schema:
          description: Array of locations (alpha-2 country codes).
          example: US
          items:
            type: string
          type: array
      - description: Filter for ip version.
        in: query
        name: ipVersion
        schema:
          description: Filter for ip version.
          example: IPv4
          items:
            enum:
            - IPv4
            - IPv6
            type: string
          type: array
      - description: Include data delay meta information
        in: query
        name: includeDelay
        schema:
          description: Include data delay meta information
          example: 'true'
          type: boolean
      - 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:
                      meta:
                        properties:
                          queries:
                            items:
                              properties:
                                dateRange:
                                  properties:
                                    endTime:
                                      example: '2024-07-29T13:30:00Z'
                                      type: string
                                    startTime:
                                      example: '2024-07-28T13:30:00Z'
                                      type: string
                                  required:
                                  - startTime
                                  - endTime
                                  type: object
                                entity:
                                  example: '174'
                                  type: string
                              required:
                              - dateRange
                              - entity
                              type: object
                            type: array
                        required:
                        - queries
                        type: object
                      serie_174:
                        properties:
                          ipv4:
                            items:
                              example: '4'
                              type: string
                            type: array
                          ipv6:
                            items:
                              example: '6'
                              type: string
                            type: array
                          timestamps:
                            items:
                              format: date-time
                              type: string
                            type: array
                        required:
                        - timestamps
                        - ipv4
                        - ipv6
                        type: object
                    required:
                    - meta
                    - serie_174
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - success
                type: object
          description: Successful Response
        '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 BGP IP space time series
      tags:
      - Radar BGP
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/leaks/events:
    get:
      description: Get the BGP route leak events (Beta).
      operationId: radar-get-bgp-route-leak-events
      parameters:
      - description: Current page number, starting from 1
        in: query
        name: page
        schema:
          description: Current page number, starting from 1
          type: integer
      - description: Number of entries per page
        in: query
        name: per_page
        schema:
          description: Number of entries per page
          type: integer
      - description: The unique identifier of a event
        in: query
        name: eventId
        schema:
          description: The unique identifier of a event
          type: integer
      - description: The leaking AS of a route leak event
        in: query
        name: leakAsn
        schema:
          description: The leaking AS of a route leak event
          type: integer
      - description: ASN that is causing or affected by a route leak event
        in: query
        name: involvedAsn
        schema:
          description: ASN that is causing or affected by a route leak event
          type: integer
      - description: Country code of a involved ASN in a route leak event
        in: query
        name: involvedCountry
        schema:
          description: Country code of a involved ASN in a route leak event
          type: string
      - 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
      - description: Sort events by field
        in: query
        name: sortBy
        schema:
          description: Sort events by field
          enum:
          - ID
          - LEAKS
          - PEERS
          - PREFIXES
          - ORIGINS
          - TIME
          example: TIME
          type: string
      - description: Sort order
        in: query
        name: sortOrder
        schema:
          description: Sort order
          enum:
          - ASC
          - DESC
          example: DESC
          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:
                      asn_info:
                        items:
                          properties:
                            asn:
                              type: integer
                            country_code:
                              type: string
                            org_name:
                              type: string
                          required:
                          - asn
                          - org_name
                          - country_code
                          type: object
                        type: array
                      events:
                        items:
                          properties:
                            countries:
                              items:
                                type: string
                              type: array
                            detected_ts:
                              type: string
                            finished:
                              type: boolean
                            id:
                              type: integer
                            leak_asn:
                              type: integer
                            leak_count:
                              type: integer
                            leak_seg:
                              items:
                                type: integer
                              type: array
                            leak_type:
                              type: integer
                            max_ts:
                              type: string
                            min_ts:
                              type: string
                            origin_count:
                              type: integer
                            peer_count:
                              type: integer
                            prefix_count:
                              type: integer
                          required:
                          - detected_ts
                          - finished
                          - id
                          - leak_asn
                          - leak_count
                          - leak_seg
                          - leak_type
                          - max_ts
                          - min_ts
                          - origin_count
                          - peer_count
                          - prefix_count
                          - countries
                          type: object
                        type: array
                    required:
                    - asn_info
                    - events
                    type: object
                  result_info:
                    properties:
                      count:
                        type: integer
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                    required:
                    - count
                    - total_count
                    - page
                    - per_page
                    type: object
                  success:
                    example: true
                    type: boolean
                required:
                - result
                - result_info
                - success
                type: object
          description: Successful Response
        '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 BGP route leak events
      tags:
      - Radar BGP
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /radar/bgp/routes/ases:
    get:
      description: List all ASes on current global routing tables with routing statistics
      operationId: radar-get-bgp-routes-asns
      parameters:
      - description: Location Alpha2 code.
        in: query
        name: location
        schema:
          description: Location Alpha2 code.
          example: US
          type: string
      - 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: Return order results by given type
        in: query
        name: sortBy
        schema:
          description: Return order results by given type
          enum:
          - cone
          - pfxs
          - ipv4
          - ipv6
          - rpki_valid
          - rpki_invalid
          - rpki_unknown
          example: ipv4
          type: string
      - description: Sort by value ascending or descending
        in: query
        name: sortOrder
        schema:
          default: desc
          description: Sort by value ascending or descending
          enum:
          - asc
          - desc
          example: desc
          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:
                      asns:
                        items:
                          properties:
                            asn:
                              type: integer
                            coneSize:
                              description: AS's customer cone size
                              type: integer
                            country:
                              description: 2-letter country code for the AS's registration country
                              example: US
                              type: string
                            ipv4Count:
                              description: number of IPv4 addresses originated by the AS
                              type: integer
                            ipv6Count:
                              description: number of IPv6 addresses originated by the AS
                              example: 1.21e24
                              type: string
                            name:
                              description: name of the AS
                              type: string
                            pfxsCount:
                              description: number of total IP prefixes originated by the AS
                              type: integer
                            rpkiInvalid:
                              description: number of RPKI invalid prefixes originated by the AS
                              type: integer
                            rpkiUnknown:
                              description: number of RPKI unknown prefixes originated by the AS
                              type: integer
                            rpkiValid:
                              description: number of RPKI valid prefixes originated by the AS
                              type: integer
                          required:
                          - asn
                          - name
                          - coneSize
                          - country
                          - ipv4Count
                          - ipv6Count
                          - pfxsCount
                          - rpkiValid
                          - rpkiInvalid
                          - rpkiUnknown
                          type: object
                        typ

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-radar-bgp-api-openapi.yml