Cloudflare Radar API

openapi: 3.0.3
info:
  title: Cloudflare / Accounts Radar API
  description: Needs description.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  version: 4.0.0
servers:
- url: https://api.cloudflare.com/client/v4
  description: Client API
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Radar
paths:
  /radar/annotations/outages:
    get:
      tags:
      - Radar
      summary: Cloudflare Get latest Internet outages and anomalies.
      operationId: radar-get-annotations-outages
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          description: Limit the number of objects in the response.
          example: 5
      - name: offset
        in: query
        schema:
          type: integer
          description: Number of objects to skip before grabbing results.
      - name: dateRange
        in: query
        schema:
          type: string
          description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          enum:
          - 1d
          - 2d
          - 7d
          - 14d
          - 28d
          - 12w
          - 24w
          - 52w
          - 1dControl
          - 2dControl
          - 7dControl
          - 14dControl
          - 28dControl
          - 12wControl
          - 24wControl
          example: 7d
      - name: dateStart
        in: query
        schema:
          type: string
          format: date-time
          description: Start of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        schema:
          type: string
          format: date-time
          description: End of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
      - name: asn
        in: query
        schema:
          type: integer
          description: Single ASN as integer.
          example: '174'
      - name: location
        in: query
        schema:
          type: string
          description: Location Alpha2 code.
          example: US
      - name: format
        in: query
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                properties:
                  result:
                    type: object
                    required:
                    - annotations
                    properties:
                      annotations:
                        type: array
                        items:
                          type: object
                          required:
                          - id
                          - dataSource
                          - startDate
                          - asns
                          - asnsDetails
                          - locations
                          - locationsDetails
                          - eventType
                          - outage
                          properties:
                            asns:
                              type: array
                              items:
                                type: integer
                                example: 189
                            asnsDetails:
                              type: array
                              items:
                                type: object
                                required:
                                - asn
                                - name
                                properties:
                                  asn:
                                    type: string
                                    example: '189'
                                  locations:
                                    type: object
                                    required:
                                    - code
                                    - name
                                    properties:
                                      code:
                                        type: string
                                        example: US
                                      name:
                                        type: string
                                        example: United States
                                  name:
                                    type: string
                                    example: LUMEN-LEGACY-L3-PARTITION
                            dataSource:
                              type: string
                              example: ALL
                            description:
                              type: string
                              example: example
                            endDate:
                              type: string
                              example: '2022-09-08T10:00:28Z'
                            eventType:
                              type: string
                              example: OUTAGE
                            id:
                              type: string
                              example: '550'
                            linkedUrl:
                              type: string
                              example: http://example.com
                            locations:
                              type: array
                              items:
                                type: string
                                example: US
                            locationsDetails:
                              type: array
                              items:
                                type: object
                                required:
                                - code
                                - name
                                properties:
                                  code:
                                    type: string
                                    example: US
                                  name:
                                    type: string
                                    example: United States
                            outage:
                              type: object
                              required:
                              - outageCause
                              - outageType
                              properties:
                                outageCause:
                                  type: string
                                  example: CABLE_CUT
                                outageType:
                                  type: string
                                  example: NATIONWIDE
                            scope:
                              type: string
                              example: Colima, Michoacán, México
                            startDate:
                              type: string
                              example: '2022-09-06T10:00:28Z'
                  success:
                    type: boolean
                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - message
                      properties:
                        message:
                          type: string
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
      security:
      - api_email: []
        api_key: []
        api_token: []
  /radar/annotations/outages/locations:
    get:
      tags:
      - Radar
      summary: Cloudflare Get the number of outages for locations.
      operationId: radar-get-annotations-outages-top
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          description: Limit the number of objects in the response.
          example: 5
      - name: dateRange
        in: query
        schema:
          type: string
          description: Shorthand date ranges for the last X days - use when you don't need specific start and end dates.
          enum:
          - 1d
          - 2d
          - 7d
          - 14d
          - 28d
          - 12w
          - 24w
          - 52w
          - 1dControl
          - 2dControl
          - 7dControl
          - 14dControl
          - 28dControl
          - 12wControl
          - 24wControl
          example: 7d
      - name: dateStart
        in: query
        schema:
          type: string
          format: date-time
          description: Start of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        schema:
          type: string
          format: date-time
          description: End of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
      - name: format
        in: query
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                properties:
                  result:
                    type: object
                    required:
                    - annotations
                    properties:
                      annotations:
                        type: array
                        items:
                          type: object
                          required:
                          - clientCountryAlpha2
                          - clientCountryName
                          - value
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: PT
                            clientCountryName:
                              type: string
                              example: Portugal
                            value:
                              type: string
                              example: '5'
                  success:
                    type: boolean
                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - message
                      properties:
                        message:
                          type: string
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
      security:
      - api_email: []
        api_key: []
        api_token: []
  /radar/as112/summary/dnssec:
    get:
      tags:
      - Radar
      summary: Cloudflare Get AS112 DNSSEC Summary
      description: Percentage distribution of DNS queries to AS112 by DNSSEC support.
      operationId: radar-get-dns-as112-timeseries-by-dnssec
      parameters:
      - name: name
        in: query
        schema:
          type: array
          description: Array of names that will be used to name the series in responses.
          example: main_series
          items:
            type: string
      - name: dateRange
        in: query
        schema:
          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).
          items:
            type: string
            enum:
            - 1d
            - 2d
            - 7d
            - 14d
            - 28d
            - 12w
            - 24w
            - 52w
            - 1dControl
            - 2dControl
            - 7dControl
            - 14dControl
            - 28dControl
            - 12wControl
            - 24wControl
      - name: dateStart
        in: query
        schema:
          type: array
          description: Array of datetimes to filter the start of a series.
          example: '2023-09-01T11:41:33.782Z'
          items:
            type: string
            format: date-time
      - name: dateEnd
        in: query
        schema:
          type: array
          description: End of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
          items:
            type: string
            format: date-time
      - name: asn
        in: query
        schema:
          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.
          example: '15169'
          items:
            type: string
      - name: location
        in: query
        schema:
          type: array
          description: Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.
          example: US,CA
          items:
            type: string
      - name: continent
        in: query
        schema:
          type: array
          description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          example: EU,NA
          items:
            type: string
      - name: format
        in: query
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                properties:
                  result:
                    type: object
                    required:
                    - meta
                    - summary_0
                    properties:
                      meta:
                        type: object
                        required:
                        - dateRange
                        - normalization
                        - lastUpdated
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  required:
                                  - dataSource
                                  - eventType
                                  - description
                                  - isInstantaneous
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    isInstantaneous:
                                      type: object
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                              level:
                                type: integer
                          dateRange:
                            type: array
                            items:
                              type: object
                              required:
                              - startTime
                              - endTime
                              properties:
                                endTime:
                                  type: string
                                  format: date-time
                                  description: Adjusted end of date range.
                                  example: '2022-09-17T10:22:57.555Z'
                                startTime:
                                  type: string
                                  format: date-time
                                  description: Adjusted start of date range.
                                  example: '2022-09-16T10:22:57.555Z'
                          lastUpdated:
                            type: string
                            example: '2023-07-26T08:59:57Z'
                          normalization:
                            type: string
                            example: PERCENTAGE
                      summary_0:
                        type: object
                        required:
                        - SUPPORTED
                        - NOT_SUPPORTED
                        properties:
                          NOT_SUPPORTED:
                            type: string
                            example: '16'
                          SUPPORTED:
                            type: string
                            example: '84'
                  success:
                    type: boolean
                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - message
                      properties:
                        message:
                          type: string
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
      security:
      - api_email: []
        api_key: []
        api_token: []
  /radar/as112/summary/edns:
    get:
      tags:
      - Radar
      summary: Cloudflare Get AS112 EDNS Summary
      description: Percentage distribution of DNS queries, to AS112, by EDNS support.
      operationId: radar-get-dns-as112-timeseries-by-edns
      parameters:
      - name: name
        in: query
        schema:
          type: array
          description: Array of names that will be used to name the series in responses.
          example: main_series
          items:
            type: string
      - name: dateRange
        in: query
        schema:
          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).
          items:
            type: string
            enum:
            - 1d
            - 2d
            - 7d
            - 14d
            - 28d
            - 12w
            - 24w
            - 52w
            - 1dControl
            - 2dControl
            - 7dControl
            - 14dControl
            - 28dControl
            - 12wControl
            - 24wControl
      - name: dateStart
        in: query
        schema:
          type: array
          description: Array of datetimes to filter the start of a series.
          example: '2023-09-01T11:41:33.782Z'
          items:
            type: string
            format: date-time
      - name: dateEnd
        in: query
        schema:
          type: array
          description: End of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
          items:
            type: string
            format: date-time
      - name: asn
        in: query
        schema:
          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.
          example: '15169'
          items:
            type: string
      - name: location
        in: query
        schema:
          type: array
          description: Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.
          example: US,CA
          items:
            type: string
      - name: continent
        in: query
        schema:
          type: array
          description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          example: EU,NA
          items:
            type: string
      - name: format
        in: query
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                properties:
                  result:
                    type: object
                    required:
                    - meta
                    - summary_0
                    properties:
                      meta:
                        type: object
                        required:
                        - dateRange
                        - normalization
                        - lastUpdated
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  required:
                                  - dataSource
                                  - eventType
                                  - description
                                  - isInstantaneous
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    isInstantaneous:
                                      type: object
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                              level:
                                type: integer
                          dateRange:
                            type: array
                            items:
                              type: object
                              required:
                              - startTime
                              - endTime
                              properties:
                                endTime:
                                  type: string
                                  format: date-time
                                  description: Adjusted end of date range.
                                  example: '2022-09-17T10:22:57.555Z'
                                startTime:
                                  type: string
                                  format: date-time
                                  description: Adjusted start of date range.
                                  example: '2022-09-16T10:22:57.555Z'
                          lastUpdated:
                            type: string
                            example: '2023-07-26T08:59:57Z'
                          normalization:
                            type: string
                            example: PERCENTAGE
                      summary_0:
                        type: object
                        required:
                        - SUPPORTED
                        - NOT_SUPPORTED
                        properties:
                          NOT_SUPPORTED:
                            type: string
                            example: '6'
                          SUPPORTED:
                            type: string
                            example: '94'
                  success:
                    type: boolean
                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - message
                      properties:
                        message:
                          type: string
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
      security:
      - api_email: []
        api_key: []
        api_token: []
  /radar/as112/summary/ip_version:
    get:
      tags:
      - Radar
      summary: Cloudflare Get AS112 IP Version Summary
      description: Percentage distribution of DNS queries to AS112 per IP Version.
      operationId: radar-get-dns-as112-timeseries-by-ip-version
      parameters:
      - name: name
        in: query
        schema:
          type: array
          description: Array of names that will be used to name the series in responses.
          example: main_series
          items:
            type: string
      - name: dateRange
        in: query
        schema:
          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).
          items:
            type: string
            enum:
            - 1d
            - 2d
            - 7d
            - 14d
            - 28d
            - 12w
            - 24w
            - 52w
            - 1dControl
            - 2dControl
            - 7dControl
            - 14dControl
            - 28dControl
            - 12wControl
            - 24wControl
      - name: dateStart
        in: query
        schema:
          type: array
          description: Array of datetimes to filter the start of a series.
          example: '2023-09-01T11:41:33.782Z'
          items:
            type: string
            format: date-time
      - name: dateEnd
        in: query
        schema:
          type: array
          description: End of the date range (inclusive).
          example: '2023-09-01T11:41:33.782Z'
          items:
            type: string
            format: date-time
      - name: asn
        in: query
        schema:
          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.
          example: '15169'
          items:
            type: string
      - name: location
        in: query
        schema:
          type: array
          description: Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.
          example: US,CA
          items:
            type: string
      - name: continent
        in: query
        schema:
          type: array
          description: Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America.
          example: EU,NA
          items:
            type: string
      - name: format
        in: query
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - JSON
          - CSV
          example: json
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                required:
                - result
                - success
                properties:
                  result:
                    type: object
                    required:
                    - meta
                    - summary_0
                    properties:
                      meta:
                        type: object
                        required:
                        - dateRange
                        - normalization
                        - lastUpdated
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  required:
                                  - dataSource
                                  - eventType
                                  - description
                                  - isInstantaneous
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    isInstantaneous:
                                      type: object
                                    linkedUrl:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                              level:
                                type: integer
                          dateRange:
                       

# --- truncated at 32 KB (1223 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/openapi/cloudflare-radar-api-openapi.yml