openapi: 3.2.0
info:
  description: Welcome to Cloudflare's API documentation site.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: Cloudflare Radar BGP API
  version: 4.0.0
servers:
- description: Client API
  url: https://api.cloudflare.com/client/v4
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Radar BGP
paths:
  /radar/bgp/hijacks/events:
    get:
      operationId: radar-get-bgp-hijacks-events
      summary: Get BGP hijack events
      description: Retrieves the BGP hijack events.
      parameters:
      - name: page
        in: query
        description: Current page number, starting from 1.
        schema:
          description: Current page number, starting from 1.
          type: integer
          default: 1
          exclusiveMinimum: 0
      - name: per_page
        in: query
        description: Number of entries per page.
        schema:
          description: Number of entries per page.
          type: integer
          default: 50
          exclusiveMinimum: 0
      - name: eventId
        in: query
        description: The unique identifier of a event.
        schema:
          description: The unique identifier of a event.
          type: integer
      - name: hijackerAsn
        in: query
        description: The potential hijacker AS of a BGP hijack event.
        schema:
          description: The potential hijacker AS of a BGP hijack event.
          type: integer
      - name: victimAsn
        in: query
        description: The potential victim AS of a BGP hijack event.
        schema:
          description: The potential victim AS of a BGP hijack event.
          type: integer
      - name: involvedAsn
        in: query
        description: The potential hijacker or victim AS of a BGP hijack event.
        schema:
          description: The potential hijacker or victim AS of a BGP hijack event.
          type: integer
      - name: involvedCountry
        in: query
        description: The country code of the potential hijacker or victim AS of a BGP hijack event.
        schema:
          description: The country code of the potential hijacker or victim AS of a BGP hijack event.
          type: string
          example: PT
          maxLength: 2
          minLength: 2
      - name: prefix
        in: query
        schema:
          example: 1.1.1.0/24
          anyOf:
          - type: string
          - type: string
      - name: minConfidence
        in: query
        description: Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high).
        schema:
          description: Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high).
          type: integer
      - name: maxConfidence
        in: query
        description: Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high).
        schema:
          description: Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high).
          type: integer
      - name: dateRange
        in: query
        description: 'Filters results by a relative date range ending at the current time. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`), e.g. `7d`. Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `3dcontrol` covers days -10 to -7, `7dcontrol` covers days -14 to -7, `28dcontrol` covers days -56 to -28, and `10dcontrol` covers days -24 to -14). Mutually exclusive with `dateStart`/`dateEnd`.'
        schema:
          description: 'Filters results by a relative date range ending at the current time. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`), e.g. `7d`. Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `3dcontrol` covers days -10 to -7, `7dcontrol` covers days -14 to -7, `28dcontrol` covers days -56 to -28, and `10dcontrol` covers days -24 to -14). Mutually exclusive with `dateStart`/`dateEnd`.'
          type: string
          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)?))$
      - name: dateStart
        in: query
        description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
        schema:
          description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: sortBy
        in: query
        description: Sorts results by the specified field.
        schema:
          description: Sorts results by the specified field.
          type: string
          example: TIME
          enum:
          - ID
          - TIME
          - CONFIDENCE
      - name: sortOrder
        in: query
        description: Sort order.
        schema:
          description: Sort order.
          type: string
          example: desc
          enum:
          - ASC
          - DESC
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asn_info:
                        type: array
                        items:
                          properties:
                            asn:
                              type: integer
                            country_code:
                              type: string
                            org_name:
                              type: string
                          required:
                          - asn
                          - org_name
                          - country_code
                          type: object
                      events:
                        type: array
                        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:
                              type: array
                              items:
                                type: integer
                            peer_ip_count:
                              type: integer
                            prefixes:
                              type: array
                              items:
                                type: string
                            tags:
                              type: array
                              items:
                                properties:
                                  name:
                                    type: string
                                  score:
                                    type: integer
                                required:
                                - name
                                - score
                                type: object
                            victim_asns:
                              type: array
                              items:
                                type: integer
                            victim_countries:
                              type: array
                              items:
                                type: string
                          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
                      total_monitors:
                        type: integer
                    required:
                    - asn_info
                    - events
                    - total_monitors
                  result_info:
                    type: object
                    properties:
                      count:
                        type: integer
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                    required:
                    - count
                    - total_count
                    - page
                    - per_page
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - result_info
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.hijacks.events
      x-fern-sdk-method-name: list
      x-forge-hidden: true
  /radar/bgp/ips/timeseries:
    get:
      operationId: radar-get-bgp-ips-timeseries
      summary: Get announced IP address space time series
      description: Retrieves time series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN.
      parameters:
      - name: name
        in: query
        description: Array of names used to label the series in the response.
        schema:
          description: Array of names used to label the series in the response.
          type: array
          items:
            example: main_series
            type: string
      - name: dateRange
        in: query
        description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
        schema:
          description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
          type: array
          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
          example: 7d
      - name: dateStart
        in: query
        description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: asn
        in: query
        description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
        schema:
          description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
          type: array
          items:
            type: string
          example: '15169'
      - name: location
        in: query
        description: Filters results by location. Specify a comma-separated list of alpha-2 location codes.
        schema:
          description: Filters results by location. Specify a comma-separated list of alpha-2 location codes.
          type: array
          items:
            type: string
          example: US
      - name: ipVersion
        in: query
        description: Filters results by IP version (Ipv4 vs. IPv6).
        schema:
          description: Filters results by IP version (Ipv4 vs. IPv6).
          type: array
          items:
            enum:
            - IPv4
            - IPv6
            type: string
          example: IPv4
      - name: includeDelay
        in: query
        description: Includes data delay meta information.
        schema:
          description: Includes data delay meta information.
          type: boolean
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        description: Metadata for the results.
                        type: object
                        properties:
                          aggInterval:
                            description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
                            type: string
                            enum:
                            - FIFTEEN_MINUTES
                            - ONE_HOUR
                            - ONE_DAY
                            - ONE_WEEK
                            - ONE_MONTH
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  description: Annotation associated with the result (e.g. outage or other type of event).
                                  properties:
                                    dataSource:
                                      description: Data source for annotations.
                                      type: string
                                      enum:
                                      - ALL
                                      - AI_BOTS
                                      - AI_GATEWAY
                                      - BGP
                                      - BOTS
                                      - CONNECTION_ANOMALY
                                      - CT
                                      - DNS
                                      - DNS_MAGNITUDE
                                      - DNS_AS112
                                      - DOS
                                      - EMAIL_ROUTING
                                      - EMAIL_SECURITY
                                      - FW
                                      - FW_PG
                                      - HTTP
                                      - HTTP_CONTROL
                                      - HTTP_CRAWLER_REFERER
                                      - HTTP_ORIGINS
                                      - IQI
                                      - LEAKED_CREDENTIALS
                                      - NET
                                      - ROBOTS_TXT
                                      - SPEED
                                      - WORKERS_AI
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endDate:
                                      type: string
                                      format: date-time
                                    eventType:
                                      description: Event type for annotations.
                                      type: string
                                      enum:
                                      - GENERAL
                                      - OUTAGE
                                      - PARTIAL_PROJECTION
                                      - PIPELINE
                                      - TRAFFIC_ANOMALY
                                    isInstantaneous:
                                      description: Whether event is a single point in time or a time range.
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                      format: uri
                                    startDate:
                                      type: string
                                      format: date-time
                                    tags:
                                      type: array
                                      items:
                                        example: BOT_CLASS
                                        type: string
                                  required:
                                  - dataSource
                                  - eventType
                                  - description
                                  - startDate
                                  - endDate
                                  - linkedUrl
                                  - isInstantaneous
                                  type: object
                              level:
                                description: Provides an indication of how much confidence Cloudflare has in the data.
                                type: integer
                            required:
                            - level
                            - annotations
                          dateRange:
                            type: array
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-17T10:22:57.555Z'
                                startTime:
                                  description: Adjusted start of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-16T10:22:57.555Z'
                              required:
                              - startTime
                              - endTime
                              type: object
                          delay:
                            type: object
                            properties:
                              asn_data:
                                type: object
                                properties:
                                  delaySecs:
                                    type: number
                                  delayStr:
                                    type: string
                                  healthy:
                                    type: boolean
                                  latest:
                                    type: object
                                    properties:
                                      entries_count:
                                        type: number
                                      path:
                                        type: string
                                      timestamp:
                                        type: number
                                    required:
                                    - timestamp
                                    - path
                                    - entries_count
                                required:
                                - delaySecs
                                - delayStr
                                - healthy
                                - latest
                              country_data:
                                type: object
                                properties:
                                  delaySecs:
                                    type: number
                                  delayStr:
                                    type: string
                                  healthy:
                                    type: boolean
                                  latest:
                                    type: object
                                    properties:
                                      count:
                                        type: number
                                      timestamp:
                                        type: number
                                    required:
                                    - timestamp
                                    - count
                                required:
                                - delaySecs
                                - delayStr
                                - healthy
                                - latest
                              healthy:
                                type: boolean
                              nowTs:
                                type: number
                            required:
                            - nowTs
                            - healthy
                            - asn_data
                            - country_data
                          lastUpdated:
                            description: Timestamp of the last dataset update.
                            type: string
                            format: date-time
                          normalization:
                            description: Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
                            type: string
                            enum:
                            - PERCENTAGE
                            - MIN0_MAX
                            - MIN_MAX
                            - RAW_VALUES
                            - PERCENTAGE_CHANGE
                            - ROLLING_AVERAGE
                            - OVERLAPPED_PERCENTAGE
                            - RATIO
                          units:
                            description: Measurement units for the results.
                            type: array
                            items:
                              properties:
                                name:
                                  type: string
                                  example: '*'
                                value:
                                  type: string
                                  example: requests
                              required:
                              - name
                              - value
                              type: object
                        required:
                        - dateRange
                        - confidenceInfo
                        - normalization
                        - lastUpdated
                        - units
                        - aggInterval
                      serie_0:
                        type: object
                        properties:
                          ipv4:
                            type: array
                            items:
                              description: A numeric string.
                              example: '10'
                              pattern: ^-?\d+(\.\d+)?$
                              type: string
                          ipv6:
                            type: array
                            items:
                              description: A numeric string.
                              example: '10'
                              pattern: ^-?\d+(\.\d+)?$
                              type: string
                          timestamps:
                            type: array
                            items:
                              format: date-time
                              type: string
                        required:
                        - timestamps
                        - ipv4
                        - ipv6
                    required:
                    - serie_0
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.ips
      x-fern-sdk-method-name: timeseries
      x-forge-hidden: true
  /radar/bgp/ips/top/ases:
    get:
      operationId: radar-get-bgp-ips-top-ases
      summary: Get top ASes by announced IP space
      description: Returns the top-N autonomous systems by announced IP space at the nearest 8-hour RIB boundary at or before the requested date. The snapped boundary is returned as `anchor_ts`.
      parameters:
      - name: date
        in: query
        description: Filters results by the specified datetime (ISO 8601).
        schema:
          description: Filters results by the specified datetime (ISO 8601).
          type: string
          format: date-time
          example: '2024-09-19T00:00:00Z'
      - name: limit
        in: query
        description: Limits the number of objects returned in the response.
        schema:
          description: Limits the number of objects returned in the response.
          type: integer
          example: 5
          default: 5
          maximum: 50
          minimum: 1
      - name: metric
        in: query
        description: 'Ranking metric: IPv4 /24 count or IPv6 /48 count.'
        schema:
          description: 'Ranking metric: IPv4 /24 count or IPv6 /48 count.'
          type: string
          example: v4_24s
          enum:
          - v4_24s
          - v6_48s
      - name: country
        in: query
        description: Optional ISO 3166-1 alpha-2 country filter. Omit for global top-N.
        schema:
          description: Optional ISO 3166-1 alpha-2 country filter. Omit for global top-N.
          type: string
          example: US
          maxLength: 2
          minLength: 2
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      anchorTs:
                        type: string
                        format: date-time
                        example: '2026-04-18T16:00:00Z'
                      asns:
                        type: array
                        items:
                          properties:
                            asn:
                              type: integer
                              example: 749
                            v4_24s:
                              type: integer
                              example: 875649
                            v6_48s:
                              type: integer
                              example: 0
                          required:
                          - asn
                          - v4_24s
                          - v6_48s
                          type: object
                      country:
                        type:
                        - string
                        - 'null'
                        example: US
                      metric:
                        type: string
                        example: v4_24s
                    required:
                    - anchorTs
                    - metric
                    - country
                    - asns
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.ips.top
      x-fern-sdk-method-name: ases
      x-forge-hidden: true
  /radar/bgp/leaks/events:
    get:
      operationId: radar-get-bgp-route-leak-events
      summary: Get BGP route leak events
      description: Retrieves the BGP route leak events.
      parameters:
      - name: page
        in: query
        description: Current page number, starting from 1.
        schema:
          description: Current page number, starting from 1.
          type: integer
          default: 1
          exclusiveMinimum: 0
      - name: per_page
        in: query
        description: Number of entries per page.
        schema:
          description: Number of entries per page.
          type: integer
          default: 50
          exclusiveMinimum: 0
      - name: eventId
        in: query
        description: The unique identifier of a event.
        schema:
          description: The unique identifier of a event.
          type: integer
      - name: leakAsn
        in: query
        description: The leaking AS of a route leak event.
        schema:
          description: The leaking AS of a route leak event.
          type: integer
      - name: involvedAsn
        in: query
        description: ASN that is causing or affected by a route leak event.
        schema:
          description: ASN that is causing or affected by a route leak event.
          type: integer
      - name: involvedCountry
        in: query
        description: Country code of a involved ASN in a route leak event.
        schema:
          description: Country code of a involved ASN in a route leak event.
          type: string
          example: PT
          maxLength: 2
          minLength: 2
      - name: dateRange
        in: query
        description: 'Filters results by a relative date range ending at the current time. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`), e.g. `7d`. Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `3dcontrol` covers days -10 to -7, `7dcontrol` covers days -14 to -7, `28dcontrol` covers days -56 to -28, and `10dcontrol` covers days -24 to -14). Mutually exclusive with `dateStart`/`dateEnd`.'
        schema:
          description: 'Filters results by a relative date range ending at the current time. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`), e.g. `7d`. Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `3dcontrol` covers days -10 to -7, `7dcontrol` covers days -14 to -7, `28dcontrol` covers days -56 to -28, and `10dcontrol` covers days -24 to -14). Mutually exclusive with `dateStart`/`dateEnd`.'
          type: string
          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)?))$
      - name: dateStart
        in: query
        description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
        schema:
          description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: sortBy
        in: query
        description: Sorts results by the specified field.
        schema:
          description: Sorts results by the specified field.
          type: string
          example: TIME
          enum:
          - ID
          - LEAKS
          - PEERS
          - PREFIXES
          - ORIGINS
          - TIME
      - name: sortOrder
        in: query
        description: Sort order.
        schema:
          description: Sort order.
          type: string
          example: desc
          enum:
          - ASC
          - DESC
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asn_info:
                        type: array
                        items:
                          properties:
                            asn:
                              type: integer
                            country_code:
                              type: string
                            org_name:
                              type: string
                          required:
                          - asn
                          - org_name
                          - country_code
                          type: object
                      events:
                        type: array
                        items:
                          properties:
                            countries:
                              type: array
                              items:
                                type: string
                            detected_ts:
                              type: string
                            finished:
                              type: boolean
                            id:
                              type: integer
                            leak_asn:
                              type: integer
                            leak_count:
                              type: integer
                            leak_seg:
                              type: array
                              items:
                                type: integer
                            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
                    required:
                    - asn_info
                    - events
                  result_info:
                    type: object
                    properties:
                      count:
                        type: integer
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                    required:
                    - count
                    - total_count
                    - page
                    - per_page
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - result_info
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.leaks.events
      x-fern-sdk-method-name: list
      x-forge-hidden: true
  /radar/bgp/routes/ases:
    get:
      operationId: radar-get-bgp-routes-asns
      summary: List ASes from global routing tables
      description: Retrieves all ASes in the current global routing tables with routing statistics.
      parameters:
      - name: location
        in: query
        description: Filters results by location. Specify an alpha-2 location code.
        schema:
          description: Filters results by location. Specify an alpha-2 location code.
          type: string
          example: US
          maxLength: 2
          minLength: 2
      - name: limit
        in: query
        description: Limits the number of objects returned in the response.
        schema:
          description: Limits the number of objects returned in the response.
          type: integer
          example: 5
          default: 5
          exclusiveMinimum: 0
      - name: sortBy
        in: query
        description: Sorts results by the specified field.
        schema:
          description: Sorts results by the specified field.
          type: string
          example: ipv4
          enum:
          - cone
          - pfxs
          - ipv4
          - ipv6
          - rpki_valid
          - rpki_invalid
          - rpki_unknown
      - name: sortOrder
        in: query
        description: Sort order.
        schema:
          description: Sort order.
          type: string
          example: desc
          enum:
          - ASC
          - DESC
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asns:
                        type: array
                        items:
                          properties:
                            asn:
                              type: integer
                            coneSize:
                              description: AS's customer cone size.
                              type: integer
                            country:
                              description: Alpha-2 code for the AS's registration country.
                              type: string
                              example: US
                            ipv4Count:
                              description: Number of IPv4 addresses originated by the AS.
                              type: integer
                            ipv6Count:
                              description: Number of IPv6 addresses originated by the AS.
                              type: string
                              example: 1.21e24
                            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
                      meta:
                        type: object
                        properties:
                          dataTime:
                            description: The timestamp of when the data is generated.
                            type: string
                            example: '2024-06-03T14:00:00'
                          queryTime:
                            description: The timestamp of the query.
                            type: string
                            example: '2024-06-03T14:00:00'
                          totalPeers:
                            description: Total number of route collector peers used to generate this data.
                            type: integer
                        required:
                        - dataTime
                        - queryTime
                        - totalPeers
                    required:
                    - asns
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.routes
      x-fern-sdk-method-name: ases
      x-forge-hidden: true
  /radar/bgp/routes/moas:
    get:
      operationId: radar-get-bgp-pfx2as-moas
      summary: Get Multi-Origin AS (MOAS) prefixes
      description: Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables.
      parameters:
      - name: origin
        in: query
        description: Lookup MOASes originated by the given ASN.
        schema:
          description: Lookup MOASes originated by the given ASN.
          type: integer
      - name: prefix
        in: query
        schema:
          example: 1.1.1.0/24
          anyOf:
          - type: string
          - type: string
      - name: invalid_only
        in: query
        description: Lookup only RPKI invalid MOASes.
        schema:
          description: Lookup only RPKI invalid MOASes.
          type: boolean
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                        - data_time
                        - query_time
                        - total_peers
                      moas:
                        type: array
                        items:
                          properties:
                            origins:
                              type: array
                              items:
                                properties:
                                  origin:
                                    type: integer
                                  peer_count:
                                    type: integer
                                  rpki_validation:
                                    type: string
                                required:
                                - origin
                                - peer_count
                                - rpki_validation
                                type: object
                            prefix:
                              type: string
                          required:
                          - prefix
                          - origins
                          type: object
                    required:
                    - moas
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.routes
      x-fern-sdk-method-name: moas
      x-forge-hidden: true
  /radar/bgp/routes/paths/{asn}:
    get:
      operationId: radar-get-bgp-routes-paths
      summary: Get tier-1 path segments for an AS
      description: Retrieves the paths an AS uses to reach the tier-1 clique, derived from RouteViews RIB snapshots. Each entry is an ordered AS-path segment (from the queried AS toward a tier-1) with the number of observed paths and peers, and the collectors that observed it. By default segments are merged across all active collectors; pass "collector" to scope to one. The response also includes an "asnInfo" map (keyed by ASN) with the name and country for every ASN in the returned segments plus the queried ASN (best-effort; null when unavailable).
      parameters:
      - name: asn
        in: path
        description: Single Autonomous System Number (ASN) as integer.
        required: true
        schema:
          description: Single Autonomous System Number (ASN) as integer.
          type: integer
          example: 174
      - name: ipVersion
        in: query
        description: Address family of the observed paths. Defaults to IPv4.
        schema:
          description: Address family of the observed paths. Defaults to IPv4.
          type: string
          example: IPv4
          default: IPv4
          enum:
          - IPv4
          - IPv6
      - name: collector
        in: query
        description: Scope to a single RouteViews collector (e.g. "route-views3"). Omit to merge across all active collectors (identical path segments are deduplicated, observation counts summed, and every contributing collector listed).
        schema:
          description: Scope to a single RouteViews collector (e.g. "route-views3"). Omit to merge across all active collectors (identical path segments are deduplicated, observation counts summed, and every contributing collector listed).
          type: string
          example: route-views3
          maxLength: 100
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asnInfo:
                        type:
                        - object
                        - 'null'
                        example:
                          '13335':
                            asn: 13335
                            country: US
                            name: Cloudflare
                        additionalProperties:
                          properties:
                            asn:
                              description: ASN number.
                              type: integer
                            country:
                              description: Alpha-2 country code.
                              type:
                              - string
                              - 'null'
                            name:
                              description: AS name.
                              type:
                              - string
                              - 'null'
                          required:
                          - asn
                          - name
                          - country
                          type: object
                      collectors:
                        type: array
                        items:
                          type: string
                      meta:
                        type: object
                        properties:
                          dataTime:
                            description: Timestamp of the underlying RIB data.
                            type:
                            - string
                            - 'null'
                            format: date-time
                          effectiveCollector:
                            type:
                            - string
                            - 'null'
                          queryTime:
                            description: Timestamp when the query was executed.
                            type:
                            - string
                            - 'null'
                            format: date-time
                          stale:
                            type: boolean
                        required:
                        - dataTime
                        - queryTime
                        - effectiveCollector
                        - stale
                      paths:
                        type: array
                        items:
                          properties:
                            collectors:
                              type: array
                              items:
                                type: string
                            pathsCount:
                              type: integer
                            peersCount:
                              type: integer
                            segment:
                              type: array
                              items:
                                type: integer
                          required:
                          - segment
                          - pathsCount
                          - peersCount
                          - collectors
                          type: object
                    required:
                    - paths
                    - collectors
                    - asnInfo
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.routes.paths
      x-fern-sdk-method-name: list
      x-forge-hidden: true
  /radar/bgp/routes/pfx2as:
    get:
      operationId: radar-get-bgp-pfx2as
      summary: Get prefix-to-ASN mapping
      description: Retrieves the prefix-to-ASN mapping from global routing tables.
      parameters:
      - name: prefix
        in: query
        schema:
          example: 1.1.1.0/24
          anyOf:
          - type: string
          - type: string
      - name: origin
        in: query
        description: Lookup prefixes originated by the given ASN.
        schema:
          description: Lookup prefixes originated by the given ASN.
          type: integer
      - name: rpkiStatus
        in: query
        description: 'Return only results with matching rpki status: valid, invalid or unknown.'
        schema:
          description: 'Return only results with matching rpki status: valid, invalid or unknown.'
          type: string
          example: INVALID
          enum:
          - VALID
          - INVALID
          - UNKNOWN
      - name: longestPrefixMatch
        in: query
        description: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.
        schema:
          description: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.
          type: boolean
          example: 'true'
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                        - data_time
                        - query_time
                        - total_peers
                      prefix_origins:
                        type: array
                        items:
                          properties:
                            origin:
                              type: integer
                            peer_count:
                              type: integer
                            prefix:
                              type: string
                            rpki_validation:
                              type: string
                          required:
                          - origin
                          - peer_count
                          - prefix
                          - rpki_validation
                          type: object
                    required:
                    - prefix_origins
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.routes
      x-fern-sdk-method-name: pfx2as
      x-forge-hidden: true
  /radar/bgp/routes/realtime:
    get:
      operationId: radar-get-bgp-routes-realtime
      summary: Get real-time BGP routes for a prefix
      description: Retrieves real-time BGP routes for a prefix, using public real-time data collectors (RouteViews and RIPE RIS).
      parameters:
      - name: prefix
        in: query
        schema:
          example: 1.1.1.0/24
          anyOf:
          - type: string
          - type: string
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          asn_info:
                            type: array
                            items:
                              properties:
                                as_name:
                                  description: Name of the autonomous system.
                                  type: string
                                asn:
                                  description: AS number.
                                  type: integer
                                country_code:
                                  description: Alpha-2 code for the AS's registration country.
                                  type: string
                                org_id:
                                  description: Organization ID.
                                  type: string
                                org_name:
                                  description: Organization name.
                                  type: string
                              required:
                              - asn
                              - as_name
                              - country_code
                              - org_id
                              - org_name
                              type: object
                          collectors:
                            type: array
                            items:
                              properties:
                                collector:
                                  description: Public route collector ID.
                                  type: string
                                latest_realtime_ts:
                                  description: Latest real-time stream timestamp for this collector.
                                  type: string
                                latest_rib_ts:
                                  description: Latest RIB dump MRT file timestamp for this collector.
                                  type: string
                                latest_updates_ts:
                                  description: Latest BGP updates MRT file timestamp for this collector.
                                  type: string
                                peers_count:
                                  description: Total number of collector peers used from this collector.
                                  type: integer
                                peers_v4_count:
                                  description: Total number of collector peers used from this collector for IPv4 prefixes.
                                  type: integer
                                peers_v6_count:
                                  description: Total number of collector peers used from this collector for IPv6 prefixes.
                                  type: integer
                              required:
                              - collector
                              - latest_realtime_ts
                              - latest_updates_ts
                              - latest_rib_ts
                              - peers_count
                              - peers_v4_count
                              - peers_v6_count
                              type: object
                          data_time:
                            description: The most recent data timestamp for from the real-time sources.
                            type: string
                          prefix_origins:
                            type: array
                            items:
                              properties:
                                origin:
                                  description: Origin ASN.
                                  type: integer
                                prefix:
                                  description: IP prefix of this query.
                                  type: string
                                rpki_validation:
                                  description: 'Prefix-origin RPKI validation: valid, invalid, unknown.'
                                  type: string
                                total_peers:
                                  description: Total number of peers.
                                  type: integer
                                total_visible:
                                  description: Total number of peers seeing this prefix.
                                  type: integer
                                visibility:
                                  description: Ratio of peers seeing this prefix to total number of peers.
                                  type: number
                              required:
                              - origin
                              - prefix
                              - rpki_validation
                              - total_peers
                              - total_visible
                              - visibility
                              type: object
                          query_time:
                            description: The timestamp of this query.
                            type: string
                        required:
                        - collectors
                        - asn_info
                        - prefix_origins
                        - data_time
                        - query_time
                      routes:
                        type: array
                        items:
                          properties:
                            as_path:
                              description: AS-level path for this route, from collector to origin.
                              type: array
                              items:
                                type: integer
                            collector:
                              description: Public collector ID for this route.
                              type: string
                            communities:
                              description: BGP community values.
                              type: array
                              items:
                                type: string
                            prefix:
                              description: IP prefix of this query.
                              type: string
                            timestamp:
                              description: Latest timestamp of change for this route.
                              type: string
                          required:
                          - timestamp
                          - collector
                          - prefix
                          - as_path
                          - communities
                          type: object
                    required:
                    - routes
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.routes
      x-fern-sdk-method-name: realtime
      x-forge-hidden: true
  /radar/bgp/routes/stats:
    get:
      operationId: radar-get-bgp-routes-stats
      summary: Get BGP routing table stats
      description: Retrieves the BGP routing table stats.
      parameters:
      - name: asn
        in: query
        description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
        schema:
          description: Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
          type: integer
          example: 174
      - name: location
        in: query
        description: Filters results by location. Specify an alpha-2 location code.
        schema:
          description: Filters results by location. Specify an alpha-2 location code.
          type: string
          example: US
          maxLength: 2
          minLength: 2
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                        - data_time
                        - query_time
                        - total_peers
                      stats:
                        type: object
                        properties:
                          distinct_origins:
                            type: integer
                          distinct_origins_ipv4:
                            type: integer
                          distinct_origins_ipv6:
                            type: integer
                          distinct_prefixes:
                            type: integer
                          distinct_prefixes_ipv4:
                            type: integer
                          distinct_prefixes_ipv6:
                            type: integer
                          routes_invalid:
                            type: integer
                          routes_invalid_ipv4:
                            type: integer
                          routes_invalid_ipv6:
                            type: integer
                          routes_total:
                            type: integer
                          routes_total_ipv4:
                            type: integer
                          routes_total_ipv6:
                            type: integer
                          routes_unknown:
                            type: integer
                          routes_unknown_ipv4:
                            type: integer
                          routes_unknown_ipv6:
                            type: integer
                          routes_valid:
                            type: integer
                          routes_valid_ipv4:
                            type: integer
                          routes_valid_ipv6:
                            type: integer
                        required:
                        - distinct_origins
                        - distinct_origins_ipv4
                        - distinct_origins_ipv6
                        - distinct_prefixes
                        - distinct_prefixes_ipv4
                        - distinct_prefixes_ipv6
                        - routes_invalid
                        - routes_invalid_ipv4
                        - routes_invalid_ipv6
                        - routes_total
                        - routes_total_ipv4
                        - routes_total_ipv6
                        - routes_unknown
                        - routes_unknown_ipv4
                        - routes_unknown_ipv6
                        - routes_valid
                        - routes_valid_ipv4
                        - routes_valid_ipv6
                    required:
                    - stats
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.routes
      x-fern-sdk-method-name: stats
      x-forge-hidden: true
  /radar/bgp/routes/upstreams/{asn}/timeseries:
    get:
      operationId: radar-get-bgp-routes-upstreams-timeseries
      summary: Get upstream composition time series for an AS
      description: Retrieves the share of an AS’s observed paths carried by each direct upstream over time, derived from RouteViews RIB snapshots across all collectors (the combined product). Each upstream ASN is returned as its own series of shares (0–1); the least-significant upstreams beyond the requested limit are grouped into an "OTHER" series. Series share a common set of timestamps.
      parameters:
      - name: asn
        in: path
        description: Single Autonomous System Number (ASN) as integer.
        required: true
        schema:
          description: Single Autonomous System Number (ASN) as integer.
          type: integer
          example: 174
      - name: ipVersion
        in: query
        description: Address family of the observed paths. Defaults to IPv4.
        schema:
          description: Address family of the observed paths. Defaults to IPv4.
          type: string
          example: IPv4
          default: IPv4
          enum:
          - IPv4
          - IPv6
      - name: dateStart
        in: query
        description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
        schema:
          description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: limit
        in: query
        description: Number of upstream ASNs to return as separate series, ranked by the first bucket. Remaining upstreams are grouped into an "OTHER" series. Defaults to 5.
        schema:
          description: Number of upstream ASNs to return as separate series, ranked by the first bucket. Remaining upstreams are grouped into an "OTHER" series. Defaults to 5.
          type: integer
          example: 5
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dataTime:
                            description: Timestamp of the underlying RIB data.
                            type:
                            - string
                            - 'null'
                            format: date-time
                          effectiveCollector:
                            type:
                            - string
                            - 'null'
                          queryTime:
                            description: Timestamp when the query was executed.
                            type:
                            - string
                            - 'null'
                            format: date-time
                          stale:
                            type: boolean
                        required:
                        - dataTime
                        - queryTime
                        - effectiveCollector
                        - stale
                      serie_0:
                        type: object
                        example:
                          '174':
                          - '0.7'
                          - '0.6'
                          OTHER:
                          - '0.1'
                          - '0.4'
                          timestamps:
                          - '2026-06-01T00:00:00Z'
                          - '2026-06-01T00:15:00Z'
                        additionalProperties:
                          items:
                            description: A numeric string.
                            example: '10'
                            pattern: ^-?\d+(\.\d+)?$
                            type: string
                          type: array
                        properties:
                          timestamps:
                            type: array
                            items:
                              format: date-time
                              type: string
                        required:
                        - timestamps
                    required:
                    - serie_0
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.routes.upstreams
      x-fern-sdk-method-name: timeseries
      x-forge-hidden: true
  /radar/bgp/rpki/aspa/changes:
    get:
      operationId: radar-get-bgp-rpki-aspa-changes
      summary: Get ASPA changes over time
      description: Retrieves ASPA (Autonomous System Provider Authorization) changes over time. Returns daily aggregated changes including additions, removals, and modifications of ASPA objects.
      parameters:
      - name: dateStart
        in: query
        description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
        schema:
          description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: asn
        in: query
        description: Filter changes involving this ASN (as customer or provider).
        schema:
          description: Filter changes involving this ASN (as customer or provider).
          type: integer
          example: 13335
      - name: includeAsnInfo
        in: query
        description: Include ASN metadata (name, country) in response.
        schema:
          description: Include ASN metadata (name, country) in response.
          type: boolean
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asnInfo:
                        type: object
                        properties:
                          '13335':
                            type: object
                            properties:
                              asn:
                                description: ASN number.
                                type: integer
                              country:
                                description: Alpha-2 country code.
                                type: string
                              name:
                                description: AS name.
                                type: string
                            required:
                            - asn
                            - name
                            - country
                        required:
                        - '13335'
                      changes:
                        type: array
                        items:
                          properties:
                            customersAdded:
                              description: Number of new ASPA objects created.
                              type: integer
                            customersRemoved:
                              description: Number of ASPA objects deleted.
                              type: integer
                            date:
                              description: Date of the changes in ISO 8601 format.
                              type: string
                              format: date-time
                            entries:
                              type: array
                              items:
                                properties:
                                  customerAsn:
                                    description: The customer ASN affected.
                                    type: integer
                                  providers:
                                    type: array
                                    items:
                                      description: Provider ASNs involved in the change.
                                      type: integer
                                  type:
                                    type: string
                                    enum:
                                    - CustomerAdded
                                    - CustomerRemoved
                                    - ProvidersAdded
                                    - ProvidersRemoved
                                required:
                                - type
                                - customerAsn
                                - providers
                                type: object
                            providersAdded:
                              description: Number of providers added to existing objects.
                              type: integer
                            providersRemoved:
                              description: Number of providers removed from existing objects.
                              type: integer
                            totalCount:
                              description: Running total of active ASPA objects after this day.
                              type: integer
                          required:
                          - date
                          - customersAdded
                          - customersRemoved
                          - providersAdded
                          - providersRemoved
                          - totalCount
                          - entries
                          type: object
                      meta:
                        type: object
                        properties:
                          dataTime:
                            description: Timestamp of the underlying data.
                            type: string
                            format: date-time
                          queryTime:
                            description: Timestamp when the query was executed.
                            type: string
                            format: date-time
                        required:
                        - dataTime
                        - queryTime
                    required:
                    - changes
                    - asnInfo
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.rpki.aspa
      x-fern-sdk-method-name: changes
      x-forge-hidden: true
  /radar/bgp/rpki/aspa/snapshot:
    get:
      operationId: radar-get-bgp-rpki-aspa-snapshot
      summary: Get ASPA objects snapshot
      description: Retrieves current or historical ASPA (Autonomous System Provider Authorization) objects. ASPA objects define which ASNs are authorized upstream providers for a customer ASN.
      parameters:
      - name: customerAsn
        in: query
        description: Filter by customer ASN (the ASN publishing the ASPA object).
        schema:
          description: Filter by customer ASN (the ASN publishing the ASPA object).
          type: integer
          example: 13335
      - name: providerAsn
        in: query
        description: Filter by provider ASN (an authorized upstream provider in ASPA objects).
        schema:
          description: Filter by provider ASN (an authorized upstream provider in ASPA objects).
          type: integer
          example: 174
      - name: date
        in: query
        description: Filters results by the specified datetime (ISO 8601).
        schema:
          description: Filters results by the specified datetime (ISO 8601).
          type: string
          format: date-time
          example: '2024-09-19T00:00:00Z'
      - name: includeAsnInfo
        in: query
        description: Include ASN metadata (name, country) in response.
        schema:
          description: Include ASN metadata (name, country) in response.
          type: boolean
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asnInfo:
                        type: object
                        properties:
                          '13335':
                            type: object
                            properties:
                              asn:
                                description: ASN number.
                                type: integer
                              country:
                                description: Alpha-2 country code.
                                type: string
                              name:
                                description: AS name.
                                type: string
                            required:
                            - asn
                            - name
                            - country
                        required:
                        - '13335'
                      aspaObjects:
                        type: array
                        items:
                          properties:
                            customerAsn:
                              description: The customer ASN publishing the ASPA object.
                              type: integer
                            providers:
                              type: array
                              items:
                                description: Authorized provider ASNs.
                                type: integer
                          required:
                          - customerAsn
                          - providers
                          type: object
                      meta:
                        type: object
                        properties:
                          dataTime:
                            description: Timestamp of the underlying data.
                            type: string
                            format: date-time
                          queryTime:
                            description: Timestamp when the query was executed.
                            type: string
                            format: date-time
                          totalCount:
                            description: Total number of ASPA objects.
                            type: integer
                        required:
                        - dataTime
                        - queryTime
                        - totalCount
                    required:
                    - aspaObjects
                    - asnInfo
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.rpki.aspa
      x-fern-sdk-method-name: snapshot
      x-forge-hidden: true
  /radar/bgp/rpki/aspa/timeseries:
    get:
      operationId: radar-get-bgp-rpki-aspa-timeseries
      summary: Get ASPA count time series
      description: Retrieves ASPA (Autonomous System Provider Authorization) object count over time. Supports filtering by RIR or location (country code) to generate multiple named series. If no RIR or location filter is specified, returns total count.
      parameters:
      - name: dateStart
        in: query
        description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
        schema:
          description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: name
        in: query
        description: Array of names used to label the series in the response.
        schema:
          description: Array of names used to label the series in the response.
          type: array
          items:
            example: main_series
            type: string
      - name: rir
        in: query
        description: Filter by Regional Internet Registry (RIR). Multiple RIRs generate multiple series.
        schema:
          description: Filter by Regional Internet Registry (RIR). Multiple RIRs generate multiple series.
          type: array
          items:
            enum:
            - RIPE_NCC
            - ARIN
            - APNIC
            - LACNIC
            - AFRINIC
            type: string
          example: RIPE_NCC
      - name: location
        in: query
        description: Filters results by location. Specify a comma-separated list of alpha-2 location codes.
        schema:
          description: Filters results by location. Specify a comma-separated list of alpha-2 location codes.
          type: array
          items:
            type: string
          example: US
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dataTime:
                            description: Timestamp of the underlying data.
                            type: string
                            format: date-time
                          queryTime:
                            description: Timestamp when the query was executed.
                            type: string
                            format: date-time
                        required:
                        - dataTime
                        - queryTime
                      serie_0:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              format: date-time
                              type: string
                          values:
                            type: array
                            items:
                              description: A numeric string.
                              example: '10'
                              pattern: ^-?\d+(\.\d+)?$
                              type: string
                        required:
                        - timestamps
                        - values
                    required:
                    - serie_0
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.rpki.aspa
      x-fern-sdk-method-name: timeseries
      x-forge-hidden: true
  /radar/bgp/rpki/roas/timeseries:
    get:
      operationId: radar-get-bgp-rpki-roas-timeseries
      summary: Get RPKI ROA deployment time series
      description: Retrieves RPKI ROA (Route Origin Authorization) validation ratios over time. Returns the selected metric as a time series. Supports filtering by ASN or location (country code) — multiple values of the same filter type produce one series per value. If no ASN or location is specified, returns the global aggregate.
      parameters:
      - name: dateStart
        in: query
        description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
        schema:
          description: Start of the date range (inclusive). Alternative to `dateRange`; provide together with `dateEnd`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`.
          type: string
          format: date-time
          example: '2023-09-01T11:41:33.782Z'
      - name: metric
        in: query
        description: Which RPKI ROA validation metric to return. validPfxsRatio = ratio of RPKI-valid prefixes (IPv4+IPv6 combined). validPfxsV4Ratio / validPfxsV6Ratio = same, split by IP version. validIpsRatio = ratio of RPKI-valid address space (IPv4 /24s + IPv6 /48s). validIpsV4Ratio / validIpsV6Ratio = same, split by IP version.
        schema:
          description: Which RPKI ROA validation metric to return. validPfxsRatio = ratio of RPKI-valid prefixes (IPv4+IPv6 combined). validPfxsV4Ratio / validPfxsV6Ratio = same, split by IP version. validIpsRatio = ratio of RPKI-valid address space (IPv4 /24s + IPv6 /48s). validIpsV4Ratio / validIpsV6Ratio = same, split by IP version.
          type: string
          example: validPfxsRatio
          default: validPfxsRatio
          enum:
          - validPfxsRatio
          - validPfxsV4Ratio
          - validPfxsV6Ratio
          - validIpsRatio
          - validIpsV4Ratio
          - validIpsV6Ratio
      - name: asn
        in: query
        description: Filters results by Autonomous System Number. Specify one or more ASNs. Multiple values generate one series per ASN.
        schema:
          description: Filters results by Autonomous System Number. Specify one or more ASNs. Multiple values generate one series per ASN.
          type: array
          items:
            type: string
          example: '13335'
      - name: location
        in: query
        description: Filters results by location. Specify a comma-separated list of alpha-2 location codes.
        schema:
          description: Filters results by location. Specify a comma-separated list of alpha-2 location codes.
          type: array
          items:
            type: string
          example: US
      - name: name
        in: query
        description: Array of names used to label the series in the response.
        schema:
          description: Array of names used to label the series in the response.
          type: array
          items:
            example: main_series
            type: string
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dataTime:
                            description: Timestamp of the underlying data.
                            type: string
                            format: date-time
                          queryTime:
                            description: Timestamp when the query was executed.
                            type: string
                            format: date-time
                        required:
                        - dataTime
                        - queryTime
                      serie_0:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              format: date-time
                              type: string
                          values:
                            type: array
                            items:
                              description: A numeric string.
                              example: '10'
                              pattern: ^-?\d+(\.\d+)?$
                              type: string
                        required:
                        - timestamps
                        - values
                    required:
                    - serie_0
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.rpki.roas
      x-fern-sdk-method-name: timeseries
      x-forge-hidden: true
  /radar/bgp/timeseries:
    get:
      operationId: radar-get-bgp-timeseries
      summary: Get BGP time series
      description: Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned.
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.
        schema:
          description: Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). When omitted, the interval is auto-selected from the requested date range; finer intervals are only available for shorter ranges. If the requested interval is too granular for the date range, the request is rejected.
          type: string
          example: 1h
          enum:
          - 15m
          - 1h
          - 1d
          - 1w
      - name: name
        in: query
        description: Array of names used to label the series in the response.
        schema:
          description: Array of names used to label the series in the response.
          type: array
          items:
            example: main_series
            type: string
      - name: dateRange
        in: query
        description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
        schema:
          description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
          type: array
          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
          example: 7d
      - name: dateStart
        in: query
        description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: prefix
        in: query
        description: Filters results by BGP network prefix.
        schema:
          description: Filters results by BGP network prefix.
          type: array
          items:
            anyOf:
            - type: string
            - type: string
          example: 1.1.1.0/24
      - name: updateType
        in: query
        description: Filters results by BGP update type.
        schema:
          description: Filters results by BGP update type.
          type: array
          items:
            enum:
            - ANNOUNCEMENT
            - WITHDRAWAL
            type: string
          example: ANNOUNCEMENT
      - name: asn
        in: query
        description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
        schema:
          description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
          type: array
          items:
            type: string
          example: '15169'
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          aggInterval:
                            type: string
                            enum:
                            - 15m
                            - 1h
                            - 1d
                            - 1w
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  description: Annotation associated with the result (e.g. outage or other type of event).
                                  properties:
                                    dataSource:
                                      description: Data source for annotations.
                                      type: string
                                      enum:
                                      - ALL
                                      - AI_BOTS
                                      - AI_GATEWAY
                                      - BGP
                                      - BOTS
                                      - CONNECTION_ANOMALY
                                      - CT
                                      - DNS
                                      - DNS_MAGNITUDE
                                      - DNS_AS112
                                      - DOS
                                      - EMAIL_ROUTING
                                      - EMAIL_SECURITY
                                      - FW
                                      - FW_PG
                                      - HTTP
                                      - HTTP_CONTROL
                                      - HTTP_CRAWLER_REFERER
                                      - HTTP_ORIGINS
                                      - IQI
                                      - LEAKED_CREDENTIALS
                                      - NET
                                      - ROBOTS_TXT
                                      - SPEED
                                      - WORKERS_AI
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endDate:
                                      type: string
                                      format: date-time
                                    eventType:
                                      description: Event type for annotations.
                                      type: string
                                      enum:
                                      - GENERAL
                                      - OUTAGE
                                      - PARTIAL_PROJECTION
                                      - PIPELINE
                                      - TRAFFIC_ANOMALY
                                    isInstantaneous:
                                      description: Whether event is a single point in time or a time range.
                                      type: boolean
                                    linkedUrl:
                                      type: string
                                      format: uri
                                    startDate:
                                      type: string
                                      format: date-time
                                    tags:
                                      type: array
                                      items:
                                        example: BOT_CLASS
                                        type: string
                                  required:
                                  - dataSource
                                  - eventType
                                  - description
                                  - startDate
                                  - endDate
                                  - linkedUrl
                                  - isInstantaneous
                                  type: object
                              level:
                                description: Provides an indication of how much confidence Cloudflare has in the data.
                                type: integer
                            required:
                            - level
                            - annotations
                          dateRange:
                            type: array
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-17T10:22:57.555Z'
                                startTime:
                                  description: Adjusted start of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-16T10:22:57.555Z'
                              required:
                              - startTime
                              - endTime
                              type: object
                          lastUpdated:
                            type: string
                            format: date-time
                        required:
                        - confidenceInfo
                        - dateRange
                        - aggInterval
                        - lastUpdated
                      serie_0:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              format: date-time
                              type: string
                          values:
                            type: array
                            items:
                              description: A numeric string.
                              example: '10'
                              pattern: ^-?\d+(\.\d+)?$
                              type: string
                        required:
                        - timestamps
                        - values
                    required:
                    - meta
                    - serie_0
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp
      x-fern-sdk-method-name: timeseries
      x-forge-hidden: true
  /radar/bgp/top/ases:
    get:
      operationId: radar-get-bgp-top-ases
      summary: Get top ASes by BGP updates
      description: Retrieves the top autonomous systems by BGP updates (announcements only).
      parameters:
      - name: limit
        in: query
        description: Limits the number of objects returned in the response.
        schema:
          description: Limits the number of objects returned in the response.
          type: integer
          example: 5
          default: 5
          exclusiveMinimum: 0
      - name: name
        in: query
        description: Array of names used to label the series in the response.
        schema:
          description: Array of names used to label the series in the response.
          type: array
          items:
            example: main_series
            type: string
      - name: dateRange
        in: query
        description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
        schema:
          description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
          type: array
          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
          example: 7d
      - name: dateStart
        in: query
        description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: asn
        in: query
        description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
        schema:
          description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
          type: array
          items:
            type: string
          example: '15169'
      - name: prefix
        in: query
        description: Filters results by BGP network prefix.
        schema:
          description: Filters results by BGP network prefix.
          type: array
          items:
            anyOf:
            - type: string
            - type: string
          example: 1.1.1.0/24
      - name: updateType
        in: query
        description: Filters results by BGP update type.
        schema:
          description: Filters results by BGP update type.
          type: array
          items:
            enum:
            - ANNOUNCEMENT
            - WITHDRAWAL
            type: string
          example: ANNOUNCEMENT
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dateRange:
                            type: array
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-17T10:22:57.555Z'
                                startTime:
                                  description: Adjusted start of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-16T10:22:57.555Z'
                              required:
                              - startTime
                              - endTime
                              type: object
                        required:
                        - dateRange
                      top_0:
                        type: array
                        items:
                          properties:
                            ASName:
                              type: string
                              example: Apple-Engineering
                            asn:
                              type: integer
                              example: 714
                            value:
                              description: Percentage of updates by this AS out of the total updates by all autonomous systems.
                              type: string
                              example: '0.73996'
                          required:
                          - asn
                          - ASName
                          - value
                          type: object
                    required:
                    - meta
                    - top_0
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.top.ases
      x-fern-sdk-method-name: get
      x-forge-hidden: true
  /radar/bgp/top/ases/prefixes:
    get:
      operationId: radar-get-bgp-top-asns-by-prefixes
      summary: Get top ASes by prefix count
      description: Retrieves the full list of autonomous systems on the global routing table ordered by announced prefixes count. The data comes from public BGP MRT data archives and updates every 2 hours.
      parameters:
      - name: country
        in: query
        description: Alpha-2 country code.
        schema:
          description: Alpha-2 country code.
          type: string
          example: NZ
      - name: limit
        in: query
        description: Maximum number of ASes to return.
        schema:
          description: Maximum number of ASes to return.
          type: integer
          example: 10
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asns:
                        type: array
                        items:
                          properties:
                            asn:
                              type: integer
                            country:
                              type: string
                            name:
                              type: string
                            pfxs_count:
                              type: integer
                          required:
                          - asn
                          - country
                          - name
                          - pfxs_count
                          type: object
                      meta:
                        type: object
                        properties:
                          data_time:
                            type: string
                          query_time:
                            type: string
                          total_peers:
                            type: integer
                        required:
                        - data_time
                        - query_time
                        - total_peers
                    required:
                    - asns
                    - meta
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found.
                required:
                - error
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.top.ases
      x-fern-sdk-method-name: prefixes
      x-forge-hidden: true
  /radar/bgp/top/prefixes:
    get:
      operationId: radar-get-bgp-top-prefixes
      summary: Get top prefixes by BGP updates
      description: Retrieves the top network prefixes by BGP updates.
      parameters:
      - name: limit
        in: query
        description: Limits the number of objects returned in the response.
        schema:
          description: Limits the number of objects returned in the response.
          type: integer
          example: 5
          default: 5
          exclusiveMinimum: 0
      - name: name
        in: query
        description: Array of names used to label the series in the response.
        schema:
          description: Array of names used to label the series in the response.
          type: array
          items:
            example: main_series
            type: string
      - name: dateRange
        in: query
        description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
        schema:
          description: 'Filters results by relative date range ending at the current time, with each value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w` for weeks (up to `52w`). Append `control` to request the equivalent previous period for comparison: the comparison window is shifted back by the current window''s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. `7dcontrol` covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass `7d` and `7dcontrol` to compare this week with the previous week. All series must resolve to the same duration as the main series; relative ranges (including `control`) satisfy this automatically. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).'
          type: array
          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
          example: 7d
      - name: dateStart
        in: query
        description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: Start of the date range. Alternative to `dateRange`; provide together with `dateEnd`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: dateEnd
        in: query
        description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
        schema:
          description: End of the date range (inclusive). Alternative to `dateRange`; provide together with `dateStart`. When requesting comparison series, every series must resolve to the same duration as the main series. Each `dateStart`/`dateEnd` is floored to the nearest 15 minutes before evaluation, so windows whose durations match only before alignment may be rejected.
          type: array
          items:
            format: date-time
            type: string
          example: '2023-09-01T11:41:33.782Z'
      - name: asn
        in: query
        description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
        schema:
          description: Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
          type: array
          items:
            type: string
          example: '15169'
      - name: updateType
        in: query
        description: Filters results by BGP update type.
        schema:
          description: Filters results by BGP update type.
          type: array
          items:
            enum:
            - ANNOUNCEMENT
            - WITHDRAWAL
            type: string
          example: ANNOUNCEMENT
      - name: format
        in: query
        description: Format in which results will be returned.
        schema:
          description: Format in which results will be returned.
          type: string
          example: json
          enum:
          - JSON
          - CSV
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dateRange:
                            type: array
                            items:
                              properties:
                                endTime:
                                  description: Adjusted end of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-17T10:22:57.555Z'
                                startTime:
                                  description: Adjusted start of date range.
                                  type: string
                                  format: date-time
                                  example: '2022-09-16T10:22:57.555Z'
                              required:
                              - startTime
                              - endTime
                              type: object
                        required:
                        - dateRange
                      top_0:
                        type: array
                        items:
                          properties:
                            prefix:
                              type: string
                              example: 2804:77cc:8000::/33
                            value:
                              description: A numeric string.
                              type: string
                              example: '10'
                              pattern: ^-?\d+(\.\d+)?$
                          required:
                          - prefix
                          - value
                          type: object
                    required:
                    - meta
                    - top_0
                  success:
                    type: boolean
                    example: true
                required:
                - result
                - success
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      properties:
                        message:
                          type: string
                      required:
                      - message
                      type: object
                  result:
                    type: object
                  success:
                    type: boolean
                    example: false
                required:
                - result
                - success
                - errors
      security:
      - api_email: []
        api_key: []
        api_token: []
      tags:
      - Radar BGP
      x-api-token-group:
      - User Details Write
      - User Details Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
      x-fern-availability: generally-available
      x-fern-sdk-group-name: radar.bgp.top
      x-fern-sdk-method-name: prefixes
      x-forge-hidden: 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
externalDocs:
  description: Cloudflare Radar Documentation
  url: https://developers.cloudflare.com/radar/
x-forge-commands:
  abuse-reports:
    description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites
    groups:
      appeals:
        description: Appeal eligibility for abuse reports
      emails:
        description: Emails sent for abuse reports
      mitigations:
        description: Mitigation actions taken in response to abuse reports
  accounts:
    description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account
    groups:
      applications:
        description: Applications operations
      categories:
        description: Categories operations
      organizations:
        description: Move accounts between organizations
      profile:
        description: View and manage the profile for a Cloudflare account
      roles:
        description: View the roles available for assigning to account members, each defining a set of permissions
      subscriptions:
        description: View and manage plan subscriptions attached to this account
      tokens:
        description: Create and manage scoped API tokens for programmatic access to the Cloudflare API
  ai-gateway:
    description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more
    groups:
      custom-domains:
        description: Manage custom hostnames that route requests through an AI Gateway
      custom-providers:
        description: Manage account-level custom AI providers and their endpoint settings
      datasets:
        description: 'Deprecated: manage filtered collections of gateway logs used by evaluations'
      dynamic-routing:
        description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments
      dynamic-routing.deployments:
        description: Deploy dynamic route versions and view deployment history
      dynamic-routing.versions:
        description: Create and inspect saved versions of a dynamic route
      evaluation-types:
        description: 'Deprecated: list the evaluator types that evaluations can use'
      evaluations:
        description: 'Deprecated: score the logs in a dataset with selected evaluator types'
      gateways:
        description: Create and configure AI Gateways for an account
      gateways.providers:
        description: Store and rotate upstream AI provider keys for a gateway
      logs:
        description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs
  ai-search:
    description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions'
    groups:
      items:
        description: Content indexed by AI Search instances
      jobs:
        description: Indexing job lifecycle for AI Search instances
      namespace:
        description: Logical groupings for organizing AI Search instances
      tokens:
        description: Credentials used by AI Search instances
  ai-security:
    description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications
    groups:
      custom-topics:
        description: Organization-specific topic categories used by AI Security for Apps content detection
  analytics:
    description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics
    groups:
      colo:
        description: Per-data-center (colo) traffic analytics breakdown for the zone
      dashboard:
        description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views
      latency:
        description: Argo Smart Routing latency analytics showing time-to-first-byte improvements
  argo:
    description: Network optimization features that speed up and improve reliability of traffic to your origins
    groups:
      smart-routing:
        description: Route traffic through the fastest network paths to your origin using real-time latency data
      tiered-caching:
        description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin
  basin-catalog:
    description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
    groups:
      credentials:
        description: Catalog access credentials for external query engines (Spark, Trino, etc.)
      maintenance-configs:
        description: Table maintenance settings — compaction schedules and snapshot expiration policies
      namespaces:
        description: Logical namespaces that group related tables within the data catalog
      namespaces.tables:
        description: Tables within catalog namespaces
      namespaces.tables.maintenance-configs:
        description: Table-level maintenance configurations and operations
      namespaces.tables.maintenance-runs:
        description: History of maintenance runs performed on tables
  billing:
    description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services
    groups:
      profiles:
        description: Billing profile with payment method, address, and invoice preferences
      usage:
        description: Metered usage data for billed services — requests, bandwidth, and feature consumption
  botnet-feed:
    description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure
    groups:
      asn:
        description: ASN-level botnet activity data showing networks with known C2 infrastructure
      configs:
        description: Botnet feed subscription configuration and notification preferences
  builds:
    description: Build and deploy Workers from connected repositories, then inspect build status and logs.
    groups:
      deploy-hooks:
        description: Manage branch-specific HTTP hooks that start builds.
      limits:
        description: View build-minute availability and refresh information.
      logs:
        description: Retrieve build logs.
      repos:
        description: Manage source repository connections for Workers Builds.
      tokens:
        description: Manage credentials used by Workers Builds to deploy Workers.
      triggers:
        description: Configure how repository changes build and deploy Workers.
      versions:
        description: Find builds associated with Worker versions.
      workers:
        description: Manage repository-backed build configuration for Workers.
  cache:
    description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving
    groups:
      origin-cloud-regions:
        description: Manage Origin Cloud Regions routing and failover configurations
      settings:
        description: Configure Cache Reserve, tiered caching, and variant serving
      settings.regional-tiered-cache:
        description: Restrict tiered cache topology to data centers within a specific geographic region
      settings.reserve:
        description: Persistent storage tier that keeps cached assets even after eviction from edge caches
      settings.smart-tiered-cache:
        description: Automatically determine the best upper-tier data centers for tiered cache topology
      settings.variants:
        description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.)
  client-side-security:
    description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks
    groups:
      connections:
        description: Third-party connections made by scripts on your pages — track data exfiltration risks
      cookies:
        description: Cookies set by your pages with classification and same-site attribute tracking
      policies:
        description: Content Security Policies that control which scripts and connections are allowed on your pages
      scripts:
        description: JavaScript files detected on your pages with change tracking and malicious code detection
      settings:
        description: Fine tune Client-Side Security behaviors
  cloud-connector:
    description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers
    groups:
      rules:
        description: Routing rules that map request patterns to cloud provider endpoints
  cloudforce-one:
    description: Detection rule management APIs
    groups:
      binary-storage:
        description: Upload and retrieve malware samples and suspicious binaries for analysis
      requests:
        description: Additional request operations — priority listing and asset creation
      rules:
        description: Rule management operations
        groups:
          approvals:
            description: Approval workflow operations
          email:
            description: Email rule operations
          exemptions:
            description: Exemption rule operations
          managed:
            description: Managed rule operations
          stats:
            description: Rule statistics operations
          tree:
            description: Rule navigation tree operations
      scans:
        description: Scan URLs, IPs, and domains for threat intelligence indicators
  containers:
    description: Deploy and manage Containers applications on Cloudflare's global network
    groups:
      applications:
        description: Manage Containers applications
      applications.instances:
        description: Inspect Containers instances belonging to applications
      applications.rollouts:
        description: Manage rollouts for scheduler-backed applications
      applications.versions:
        description: Inspect versions of scheduler-backed applications
      registries:
        description: Manage Containers image registries
      registries.credentials:
        description: Generate image registry credentials
  content-scan:
    description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads
    groups:
      expressions:
        description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own
  custom-pages:
    description: Manage custom error and challenge pages and their assets for accounts and zones
    groups:
      account-custom-pages:
        description: Manage account-level custom pages
      account-custom-pages.preview-tokens:
        description: Preview tokens for account-level custom pages
      assets:
        description: Manage account- and zone-level custom assets
      zone-custom-pages:
        description: Manage zone-level custom pages
      zone-custom-pages.preview-tokens:
        description: Preview tokens for zone-level custom pages
  d1:
    description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access.
    groups:
      time-travel:
        description: use specific point-in-time backups of your D1 database
        x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel
  diagnostics:
    description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks
    groups:
      endpoint-healthchecks:
        description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks
      traceroutes:
        description: Run traceroutes from Cloudflare data centers to diagnose network path issues
  email-routing:
    description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records
    groups:
      addresses:
        description: Verified destination email addresses that can receive forwarded mail
      dns:
        description: Inspect or unlock the DNS records required by Email Routing
      rules:
        description: Match incoming email addresses and forward messages to destination mailboxes or Workers
      settings:
        description: Inspect and update Email Routing settings
  email-security:
    description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing
    groups:
      analytics:
        description: Analytics and reporting — monthly report and per-day breakdowns of threat activity
      bulk-actions:
        description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs
      investigate:
        description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions
      phishguard:
        description: PhishGuard user-reported phishing reports — view detected threats for a date range
      settings:
        description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling
      submissions:
        description: Reclassify submissions — track user and team reports of false positives and missed detections
  email-sending:
    description: Send transactional email and manage sending subdomains and their DNS configuration
    groups:
      limits:
        description: Inspect account-level sending quotas and current usage
      subdomains:
        description: Configure sending subdomains and keep their DNS records healthy
      suppressions:
        description: Prevent delivery to suppressed addresses and manage the account suppression list
  filters:
    description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations
  firewall:
    description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages
    groups:
      access-rules:
        description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone
      lockdowns:
        description: Zone lockdown rules that restrict access to URLs by IP address or range
      rules:
        description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations
      ua-rules:
        description: Block or challenge requests based on the User-Agent header string
      waf:
        description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations
      zone-access-rules:
        description: Zone-scoped IP access rules for blocking or allowing traffic
  google-tag-gateway:
    description: Google Tag Gateway operations
    groups:
      config:
        description: Google Tag Gateway config operations
  healthchecks:
    description: Standalone health checks that monitor origin server availability from Cloudflare's edge
    groups:
      previews:
        description: Test a health check configuration before deploying it to production
  hyperdrive:
    description: Accelerate access to existing databases by caching queries and pooling connections at the edge
  iam:
    description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors
    groups:
      permission-groups:
        description: View the permission groups that can be assigned to API tokens and policies
      resource-groups:
        description: Define scopes that limit which account resources a policy or token can access
      sso:
        description: Configure single sign-on connectors to authenticate account members through an external identity provider
      user-groups:
        description: Organize account members into groups for easier permission assignment
  images:
    description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads
    groups:
      flows:
        description: Zone-level transformation flows that control how images are resized and optimized on delivery
      import:
        description: Import images from S3
      keys:
        description: Manage signing keys for generating private image URLs
      variants:
        description: Manage named resize variants for transforming images on delivery
  intel:
    description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds
    groups:
      asn:
        description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems
      attack-surface-report:
        description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping
      dns:
        description: Passive DNS data showing historical DNS resolution records for domains
      domain-history:
        description: Historical domain registration and categorization changes over time
      domains:
        description: Domain intelligence — risk scores, categories, and associated infrastructure
      indicator-feeds:
        description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs
      ip-lists:
        description: Curated IP lists used for threat detection and policy enforcement
      ips:
        description: IP address intelligence — geolocation, risk assessment, and hosting provider details
      miscategorizations:
        description: Report and track domain miscategorization corrections
      whois:
        description: WHOIS registration data for domains including registrant, registrar, and nameservers
  k2:
    description: Durable, ordered event streams that you produce records to and consume from with subscriptions
    groups:
      streams:
        description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records
      streams.subscriptions:
        description: Subscriptions that consume a K2 stream, with committed-position lag
  leaked-credential-checks:
    description: Detect compromised credentials in login requests by checking against known breach databases
    groups:
      detections:
        description: Custom detection locations that tell the WAF where to find usernames and passwords in requests
  load-balancers:
    description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover
    groups:
      monitor-groups:
        description: Group monitors together for shared configuration and bulk management
      monitor-groups.references:
        description: List references to monitor groups used by load balancer pools
      monitors:
        description: Health check configurations that probe origin servers and determine pool availability
      monitors.previews:
        description: Health check configurations that probe origin servers and determine pool availability
      monitors.references:
        description: Health check configurations that probe origin servers and determine pool availability
      pools:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      pools.health:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      pools.references:
        description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
      previews:
        description: Preview the result of a health check monitor configuration before applying it
      regions:
        description: Geographic regions used for regional pool steering and traffic policies
      searches:
        description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference
  logs:
    description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields
    groups:
      control:
        description: Log control operations
      received:
        description: Received log operations
  magic-network-monitoring:
    description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion
    groups:
      configs:
        description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings
      rules:
        description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements
      vpc-flows:
        description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection
  magic-transit:
    description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures
    groups:
      advanced-dns-protection:
        description: Advanced Dns Protection operations
      advanced-tcp-protection:
        description: Advanced Tcp Protection operations
      apps:
        description: Application-aware traffic policies for Magic WAN that steer traffic by app type
      bgp-filter-profiles:
        description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels
      bgp-settings:
        description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels
      cf-interconnects:
        description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering
      gre-tunnels:
        description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit
      ipsec-tunnels:
        description: IPsec tunnel endpoints with pre-shared key management for encrypted transit
      pcaps:
        description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels
      routes:
        description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels
      sites:
        description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config
  mcp:
    description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls
    groups:
      portals:
        description: Manage MCP portals, attached servers, and Code Mode settings
      servers:
        description: Manage upstream MCP servers, credentials, capabilities, and sync state
  network-interconnects:
    description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network
    groups:
      cnis:
        description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare
      interconnects:
        description: Physical cross-connect and partner interconnect sessions with LOA and status tracking
      settings:
        description: Account-level interconnect settings and default configurations
      slots:
        description: Available interconnect facility slots showing port capacity at Cloudflare data centers
  organizations:
    description: Multi-user organizations that group accounts, members, and shared settings under a single entity
    groups:
      account-organizations:
        description: List organizations associated with a specific account
      accounts:
        description: Accounts operations
      members:
        description: Members operations
      members-batch-create:
        description: Members Batch Create operations
      organization-profile:
        description: View and update the public profile information for an organization
      shares:
        description: Shares operations
  origin-post-quantum-encryption:
    description: Enable post-quantum key exchange for connections between Cloudflare and your origin server
  pages:
    description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains
    groups:
      projects:
        description: Pages projects, deployments, build logs, and custom domain bindings
  pipelines:
    description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time
    groups:
      sinks:
        description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage
      streams:
        description: Inbound data streams that feed events into a pipeline for processing
  precursor:
    description: Precursor settings for a zone
  queues:
    description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale
    groups:
      consumers:
        description: Workers that automatically receive and process messages from a queue
      messages:
        description: Push messages to a queue and pull or acknowledge them from consumers
      purge:
        description: Remove all pending messages from a queue
      subscriptions:
        description: Manage queue subscriptions for event-driven message routing
  r2:
    description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration
    groups:
      buckets:
        description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks
      buckets.jobs:
        description: Create and inspect background jobs for an R2 bucket
      buckets.local-uploads:
        description: R2 bucket local upload configuration
      super-slurper:
        description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs
      temporary-credentials:
        description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations
  r2-data-catalog:
    description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
    groups:
      credentials:
        description: Catalog access credentials for external query engines (Spark, Trino, etc.)
      maintenance-configs:
        description: Table maintenance settings — compaction schedules and snapshot expiration policies
      namespaces:
        description: Logical namespaces that group related tables within the data catalog
      namespaces.tables:
        description: Tables within catalog namespaces
      namespaces.tables.maintenance-configs:
        description: Table-level maintenance configurations and operations
      namespaces.tables.maintenance-runs:
        description: History of maintenance runs performed on tables
  radar:
    description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights
    groups:
      agent-readiness:
        description: Agent readiness summary statistics across the Cloudflare network
      ai:
        description: AI inference trends and model usage statistics across the Cloudflare network
      annotations:
        description: Radar annotations marking significant Internet events (outages, cable cuts, etc.)
      as112:
        description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space
      attacks:
        description: DDoS and application-layer attack trends, vectors, and target analysis
      bgp:
        description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events
      bots:
        description: Internet-wide bot traffic trends, categories, and distribution statistics
      ct:
        description: Certificate Transparency log monitoring and newly-issued certificate discovery
      datasets:
        description: Downloadable Radar datasets for offline analysis and research
      dns:
        description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption
      email:
        description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics
      entities:
        description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries
      geolocations:
        description: Geographic location metadata used for regional traffic analysis
      http:
        description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution
      leaked-credentials:
        description: Leaked credential detection trends and exposure statistics
      netflows:
        description: Network-layer traffic flow data and volumetric trend analysis
      origins:
        description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics
      post-quantum:
        description: Post-quantum encryption adoption and deployment trends across the Internet
      quality:
        description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN
      ranking:
        description: Top domain rankings based on DNS query popularity across the Cloudflare network
      robots-txt:
        description: Robots.txt adoption and crawler directive trends across the web
      search:
        description: Search Radar data across IPs, ASNs, domains, and locations
      tcp-resets-timeouts:
        description: TCP connection reset and timeout statistics indicating network health issues
      tlds:
        description: Top-level domain (TLD) metadata and performance trends
      traffic-anomalies:
        description: Detected traffic anomalies and unusual patterns in Internet traffic flows
      verified-bots:
        description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns
  rate-limits:
    description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations
  realtime:
    description: Real-time audio, video, and data services on Cloudflare's global network
    groups:
      kit:
        description: SDK-backed meetings, participants, recordings, livestreams, and webhooks
      kit.analytics:
        description: Usage and livestream analytics for RealtimeKit applications
      kit.analytics.livestreams:
        description: Livestream analytics for RealtimeKit applications
      kit.analytics.livestreams.daily:
        description: Daily livestream analytics for RealtimeKit applications
      kit.analytics.usage:
        description: Usage analytics for RealtimeKit applications
      kit.apps:
        description: RealtimeKit applications that group meetings, sessions, and configuration
      kit.livestreams:
        description: Independent and meeting-based livestreams and their sessions
      kit.livestreams.sessions:
        description: Sessions for RealtimeKit livestreams
      kit.meetings:
        description: Meetings, participants, access tokens, and meeting livestreams
      kit.meetings.active:
        description: Live meeting state and participant controls
      kit.meetings.active.polls:
        description: Polls for active meeting sessions
      kit.meetings.livestream:
        description: Livestream operations associated with RealtimeKit meetings
      kit.meetings.participants:
        description: Participants in RealtimeKit meetings
      kit.meetings.participants.tokens:
        description: Access tokens for RealtimeKit meeting participants
      kit.presets:
        description: Reusable meeting configuration for media, permissions, and interface behavior
      kit.recordings:
        description: Meeting and participant-track recordings and recording controls
      kit.recordings.active:
        description: Active recordings for RealtimeKit meetings
      kit.recordings.tracks:
        description: Participant-track recordings for RealtimeKit meetings
      kit.sessions:
        description: Historical session data, participants, chat, transcripts, and summaries
      kit.sessions.chat:
        description: Chat messages from historical RealtimeKit sessions
      kit.sessions.livestreams:
        description: Livestreams associated with historical RealtimeKit sessions
      kit.sessions.participants:
        description: Participants in historical RealtimeKit sessions
      kit.sessions.peers:
        description: Peer details from historical RealtimeKit sessions
      kit.sessions.summaries:
        description: Summaries of historical RealtimeKit sessions
      kit.sessions.transcripts:
        description: Transcripts from historical RealtimeKit sessions
      kit.webhooks:
        description: Webhook endpoints and supported events for RealtimeKit notifications
      kit.webhooks.events:
        description: Supported events for RealtimeKit webhooks
      moq:
        description: MoQ relays for publishing and subscribing to media streams
      moq.relays:
        description: Relays are isolated MoQ scopes that carry media between publishers and subscribers
      moq.relays.tokens:
        description: Tokens that authorize publishers and subscribers to connect to a relay
      sfu:
        description: SFU apps that route WebRTC media and data between participants
      sfu.apps:
        description: SFU application namespaces for sessions and tracks
      turn:
        description: TURN keys that help clients traverse NATs and firewalls
      turn.keys:
        description: Keys used to generate short-lived TURN credentials
  request-tracers:
    description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline
    groups:
      traces:
        description: Simulate request processing to debug rule matches, transforms, and routing decisions
  resource-sharing:
    description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls
    groups:
      recipients:
        description: Update share recipients
      resources:
        description: Individual resources (zones, configs) that have been shared with recipients
  rules:
    description: Resources used by Cloudflare rules and rulesets
    groups:
      lists:
        description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions
  rum:
    description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics
    groups:
      rules:
        description: Rules that control which pages and paths are tracked by Web Analytics
      site-info:
        description: Web Analytics sites — register domains and get the JavaScript beacon snippet
  scim:
    description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account
    groups:
      groups:
        description: Groups operations
      resource-types:
        description: Resource Types operations
      schemas:
        description: Schemas operations
      service-provider-config:
        description: Service Provider Config operations
      users:
        description: Users operations
  secrets-store:
    description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products
    groups:
      quota:
        description: Account quota limits for secrets stores, secrets count, and storage capacity
      secrets:
        description: Encrypted key-value secrets within a store. Pass --store-id to scope.
      stores:
        description: Secret stores that hold encrypted key-value secrets accessible by Workers and services
  security-center:
    description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities
    groups:
      insights:
        description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc.
      zone-insights:
        description: Zone-scoped security insights — counts by class, severity, type, and dismissal
  security-txt:
    description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities
  smart-shield:
    description: Smart Shield settings, health checks, and cache reserve management
    groups:
      cache-reserve-clear:
        description: Cache Reserve Clear operations
      health-checks:
        description: Health checks operations
  spectrum:
    description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation
    groups:
      analytics:
        description: Real-time and historical connection analytics for Spectrum applications
      apps:
        description: Spectrum application configurations that map protocols and ports to origin servers
  speed:
    description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests
    groups:
      availabilities:
        description: Check which speed test regions and configurations are available for your zone
      pages:
        description: Tested pages with their performance history, trends, and individual test results
      schedule:
        description: Scheduled recurring speed tests that automatically run at regular intervals
  ssl:
    description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations
    groups:
      automatic-upgrader:
        description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings
      recommendations:
        description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration
  stream:
    description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale
    groups:
      audio-tracks:
        description: Add, edit, or remove additional audio tracks on a video
      captions:
        description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages
      clip:
        description: Create a new video clip from an existing video by specifying start and end times
      copy:
        description: Import a video from a URL into Stream for processing and delivery
      direct-upload:
        description: Generate a tokenized URL that lets end-users upload video directly to Stream
      downloads:
        description: Create downloadable MP4 renditions of a video for offline viewing
      embed:
        description: Retrieve the HTML embed code snippet for a video
      keys:
        description: Signing keys used to generate short-lived signed URLs for private video playback
      live-inputs:
        description: Enable and disable live input streams
      token:
        description: Generate short-lived signed URL tokens for secure private video playback
      typed-downloads:
        description: Type-specific stream download creation and deletion
      videos:
        description: Aggregate video storage usage statistics for the account
      watermarks:
        description: Watermark profiles that overlay an image on every video in the account
      webhooks:
        description: Webhook notifications for video lifecycle events (ready, error, etc.)
  tenants:
    description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships
    groups:
      account-types:
        description: Account Types operations
      accounts:
        description: Accounts operations
      entitlements:
        description: Entitlements operations
      memberships:
        description: Memberships operations
  turnstile:
    description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience
    groups:
      widgets:
        description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings
  url-scanner:
    description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results
    groups:
      response:
        description: Response operations
      responses:
        description: Raw HTTP response data captured during URL scans
      scan:
        description: Scan operations
      scans:
        description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts
  user:
    description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens
    groups:
      billing:
        description: View billing history and payment profile for your user (deprecated — prefer account-level billing)
      firewall:
        description: Firewall operations
      load-balancers.monitors:
        description: Load Balancers operations
      load-balancers.monitors.preview:
        description: Load Balancers operations
      load-balancers.monitors.references:
        description: Load Balancers operations
      load-balancers.pools:
        description: Load Balancers operations
      load-balancers.pools.edit.pools:
        description: Load Balancers operations
      load-balancers.pools.health:
        description: Load Balancers operations
      load-balancers.pools.preview:
        description: Load Balancers operations
      load-balancers.pools.references:
        description: Load Balancers operations
      load-balancers.preview:
        description: Load Balancers operations
      load-balancing-analytics.events:
        description: Load Balancing Analytics operations
      subscriptions:
        description: View and manage zone-level plan subscriptions owned by your user
      tenants:
        description: Tenants operations
      tokens:
        description: Create and manage personal API tokens scoped to your user for programmatic API access
  user.analytics:
    description: User-level traffic analytics — aggregated totals and timeseries across all zones
  vectorize:
    description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers
    groups:
      deprecated-indexes:
        description: Deprecated v1 Vectorize index operations
      metadata-index:
        description: Metadata indexes for filtered vector search
  waiting-rooms:
    description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages
    groups:
      account-waiting-rooms:
        description: Account-scoped waiting room listing
      events:
        description: Scheduled events that temporarily override waiting room settings for sales, launches, etc.
      page:
        description: Custom HTML waiting page templates and preview rendering
      rules:
        description: Rules that bypass or modify waiting room behavior for specific request patterns
      settings:
        description: Zone-level waiting room defaults and cookie configuration
      statuses:
        description: Real-time queue status showing active users, queued users, and estimated wait times
  workflows:
    description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence
    groups:
      instances:
        description: Workflow instance operations
      versions:
        description: Workflow version operations
  zaraz:
    description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS
    groups:
      config:
        description: Full Zaraz configuration including tools, triggers, and variables for the zone
      default:
        description: Default Zaraz configuration template used as a starting point for new zones
      export:
        description: Export the current Zaraz configuration as a portable JSON document
      history:
        description: Configuration version history — browse and restore previous Zaraz configurations
      publish:
        description: Publish pending Zaraz configuration changes to make them live on the zone
      workflow:
        description: Workflow state for Zaraz configuration changes (draft vs. published)
  zero-trust:
    description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation
    groups:
      dex:
        description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics
      dlp.custom-prompt-topics:
        description: Data Loss Prevention - manage custom prompt topics for AI-based content detection
      dlp.data-classes:
        description: Data Loss Prevention - manage data classes used to classify sensitive information
      dlp.data-tag-categories:
        description: Data Loss Prevention - manage categories that organize data tags
      dlp.data-tag-category-templates:
        description: Data Loss Prevention - browse templates for creating data tag categories
      dlp.data-tags:
        description: Data Loss Prevention - manage tags used to classify and organize sensitive data
      dlp.datasets:
        description: Data Loss Prevention - manage datasets, versions, and uploads
      dlp.document-fingerprints:
        description: Data Loss Prevention - manage document fingerprints for detecting matching documents
      dlp.email.account-mapping:
        description: Data Loss Prevention - configure account mappings for outbound email scanning
      dlp.email.rules:
        description: Data Loss Prevention - manage outbound email scanning rules and their priorities
      dlp.entries:
        description: Data Loss Prevention - list and manage detection entries
      dlp.limits:
        description: Data Loss Prevention - view account limits and resource quotas
      dlp.patterns:
        description: Data Loss Prevention - validate regular expressions used for content detection
      dlp.profiles:
        description: Data Loss Prevention - list and retrieve profiles
      dlp.profiles.custom:
        description: Data Loss Prevention - manage custom profiles
      dlp.profiles.predefined:
        description: Data Loss Prevention - manage predefined profiles
      dlp.sensitivity-group-templates:
        description: Data Loss Prevention - browse templates for creating sensitivity groups
      dlp.sensitivity-groups:
        description: Data Loss Prevention - manage sensitivity groups and their level ordering
      dlp.sensitivity-levels:
        description: Data Loss Prevention - manage sensitivity levels within sensitivity groups
      dlp.settings:
        description: Data Loss Prevention - manage account-level settings
      dlp.validators:
        description: Data Loss Prevention - list and retrieve content validators
      dlp.validators.proximity-words:
        description: Data Loss Prevention - manage proximity-word validators
      risk-scoring:
        description: User Risk Scoring - retrieve and reset user risk scores
      risk-scoring.behaviours:
        description: User Risk Scoring - manage behaviors used to calculate user risk scores
      risk-scoring.integrations:
        description: User Risk Scoring - manage integrations that provide risk score signals
      risk-scoring.integrations.references:
        description: User Risk Scoring - retrieve integrations by external reference
      risk-scoring.summary:
        description: User Risk Scoring - retrieve account risk score summaries
  zones:
    description: Zones are domains on Cloudflare — list, create, and configure domain settings
    groups:
      aegis:
        description: Aegis operations
      fonts:
        description: Fonts operations
      origin-h2-max-streams:
        description: Origin H2 Max Streams operations
      origin-max-http-version:
        description: Origin Max Http Version operations
      origin-tls-compliance-modes:
        description: Manage zone Origin TLS Compliance Modes setting
      rum:
        description: Rum operations
      speed-brain:
        description: Speed Brain operations