openapi: 3.0.3 components: schemas: {} info: title: 'Cloudflare radar/' description: Needs description. license: name: BSD-3-Clause url: https://opensource.org/licenses/BSD-3-Clause version: 4.0.0 paths: /radar/annotations/outages: get: tags: - Radar summary: Cloudflare Get latest Internet outages and anomalies. operationId: radar-get-annotations-outages parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: dateRange in: query schema: type: string description: >- Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: asn in: query schema: type: integer description: Single ASN as integer. example: '174' - name: location in: query schema: type: string description: Location Alpha2 code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - annotations properties: annotations: type: array items: type: object required: - id - dataSource - startDate - asns - asnsDetails - locations - locationsDetails - eventType - outage properties: asns: type: array items: type: integer example: 189 asnsDetails: type: array items: type: object required: - asn - name properties: asn: type: string example: '189' locations: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States name: type: string example: LUMEN-LEGACY-L3-PARTITION dataSource: type: string example: ALL description: type: string example: example endDate: type: string example: '2022-09-08T10:00:28Z' eventType: type: string example: OUTAGE id: type: string example: '550' linkedUrl: type: string example: http://example.com locations: type: array items: type: string example: US locationsDetails: type: array items: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States outage: type: object required: - outageCause - outageType properties: outageCause: type: string example: CABLE_CUT outageType: type: string example: NATIONWIDE scope: type: string example: Colima, Michoacán, México startDate: type: string example: '2022-09-06T10:00:28Z' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/annotations/outages/locations: get: tags: - Radar summary: Cloudflare Get the number of outages for locations. operationId: radar-get-annotations-outages-top parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: dateRange in: query schema: type: string description: >- Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - annotations properties: annotations: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: PT clientCountryName: type: string example: Portugal value: type: string example: '5' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/dnssec: get: tags: - Radar summary: Cloudflare Get AS112 DNSSEC Summary description: Percentage distribution of DNS queries to AS112 by DNSSEC support. operationId: radar-get-dns-as112-timeseries-by-dnssec parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: string example: '16' SUPPORTED: type: string example: '84' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/edns: get: tags: - Radar summary: Cloudflare Get AS112 EDNS Summary description: Percentage distribution of DNS queries, to AS112, by EDNS support. operationId: radar-get-dns-as112-timeseries-by-edns parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: string example: '6' SUPPORTED: type: string example: '94' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/ip_version: get: tags: - Radar summary: Cloudflare Get AS112 IP Version Summary description: Percentage distribution of DNS queries to AS112 per IP Version. operationId: radar-get-dns-as112-timeseries-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: '80' IPv6: type: string example: '20' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/protocol: get: tags: - Radar summary: Cloudflare Get AS112 DNS Protocol Summary description: Percentage distribution of DNS queries to AS112 per protocol. operationId: radar-get-dns-as112-timeseries-by-protocol parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - udp - tcp properties: tcp: type: string example: '1' udp: type: string example: '99' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/query_type: get: tags: - Radar summary: Cloudflare Get AS112 Query Types Summary description: Percentage distribution of DNS queries to AS112 by Query Type. operationId: radar-get-dns-as112-timeseries-by-query-type parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - PTR - A - SOA - AAAA - SRV properties: A: type: string example: '19' AAAA: type: string example: '1' PTR: type: string example: '74' SOA: type: string example: '5' SRV: type: string example: '1' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/summary/response_codes: get: tags: - Radar summary: Cloudflare Get a summary of AS112 Response Codes description: >- Percentage distribution of AS112 dns requests classified per Response Codes. operationId: radar-get-dns-as112-timeseries-by-response-codes parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NXDOMAIN - NOERROR properties: NOERROR: type: string example: '6' NXDOMAIN: type: string example: '94' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries: get: tags: - Radar summary: Cloudflare Get AS112 DNS Queries Time Series description: Get AS112 queries change over time. operationId: radar-get-dns-as112-timeseries parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/dnssec: get: tags: - Radar summary: Cloudflare Get AS112 DNSSEC Support Time Series description: >- Percentage distribution of DNS AS112 queries by DNSSEC support over time. operationId: radar-get-dns-as112-timeseries-group-by-dnssec parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: array items: type: string example: '16' SUPPORTED: type: array items: type: string example: '84' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/edns: get: tags: - Radar summary: Cloudflare Get AS112 EDNS Support Summary description: Percentage distribution of AS112 DNS queries by EDNS support over time. operationId: radar-get-dns-as112-timeseries-group-by-edns parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SUPPORTED - NOT_SUPPORTED properties: NOT_SUPPORTED: type: array items: type: string example: '6' SUPPORTED: type: array items: type: string example: '94' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/ip_version: get: tags: - Radar summary: Cloudflare Get AS112 IP Version Time Series description: Percentage distribution of AS112 DNS queries by IP Version over time. operationId: radar-get-dns-as112-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: array items: type: string example: '80' IPv6: type: array items: type: string example: '20' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/protocol: get: tags: - Radar summary: Cloudflare Get AS112 DNS Protocol Time Series description: >- Percentage distribution of AS112 dns requests classified per Protocol over time. operationId: radar-get-dns-as112-timeseries-group-by-protocol parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - udp - tcp properties: tcp: type: array items: type: string example: '1' udp: type: array items: type: string example: '99' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/query_type: get: tags: - Radar summary: Cloudflare Get AS112 Query Types Time Series description: Percentage distribution of AS112 DNS queries by Query Type over time. operationId: radar-get-dns-as112-timeseries-group-by-query-type parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - PTR - A - SOA - AAAA - SRV properties: A: type: array items: type: string example: '19' AAAA: type: array items: type: string example: '1' PTR: type: array items: type: string example: '74' SOA: type: array items: type: string example: '5' SRV: type: array items: type: string example: '1' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/timeseries_groups/response_codes: get: tags: - Radar summary: Cloudflare Get a time series of AS112 Response Codes description: >- Percentage distribution of AS112 dns requests classified per Response Codes over time. operationId: radar-get-dns-as112-timeseries-group-by-response-codes parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NXDOMAIN - NOERROR properties: NOERROR: type: array items: type: string example: '6' NXDOMAIN: type: array items: type: string example: '94' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations: get: tags: - Radar summary: Cloudflare Get top autonomous systems by AS112 DNS queries description: >- Get the top locations by AS112 DNS queries. Values are a percentage out of the total queries. operationId: radar-get-dns-as112-top-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations/dnssec/{dnssec}: get: tags: - Radar summary: Cloudflare Get Top Locations By DNS Queries DNSSEC Support description: Get the top locations by DNS queries DNSSEC support to AS112. operationId: radar-get-dns-as112-top-locations-by-dnssec parameters: - name: dnssec in: path required: true schema: type: string description: DNSSEC. enum: - SUPPORTED - NOT_SUPPORTED example: SUPPORTED - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations/edns/{edns}: get: tags: - Radar summary: Cloudflare Get Top Locations By EDNS Support description: Get the top locations, by DNS queries EDNS support to AS112. operationId: radar-get-dns-as112-top-locations-by-edns parameters: - name: edns in: path required: true schema: type: string description: EDNS. enum: - SUPPORTED - NOT_SUPPORTED example: SUPPORTED - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/as112/top/locations/ip_version/{ip_version}: get: tags: - Radar summary: Cloudflare Get Top Locations by DNS Queries IP version description: Get the top locations by DNS queries IP version to AS112. operationId: radar-get-dns-as112-top-locations-by-ip-version parameters: - name: ip_version in: path required: true schema: type: string description: IP Version. enum: - IPv4 - IPv6 example: IPv4 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary: get: tags: - Radar summary: Cloudflare Get Layer 3 Attacks Summary description: >- Percentage distribution of network protocols in layer 3/4 attacks over a given time period. operationId: radar-get-attacks-layer3-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' summary_0: type: object required: - tcp - udp - gre - icmp properties: gre: type: string example: '0.9' icmp: type: string example: '0.1' tcp: type: string example: '60' udp: type: string example: '39' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/bitrate: get: tags: - Radar summary: Cloudflare Get Attack Bitrate Summary description: Percentage distribution of attacks by bitrate. operationId: radar-get-attacks-layer3-summary-by-bitrate parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - UNDER_500_MBPS - OVER_100_GBPS - _1_GBPS_TO_10_GBPS - _500_MBPS_TO_1_GBPS - _10_GBPS_TO_100_GBPS properties: _1_GBPS_TO_10_GBPS: type: string example: '6.007082' _10_GBPS_TO_100_GBPS: type: string example: '0.01056' _500_MBPS_TO_1_GBPS: type: string example: '5.948652' OVER_100_GBPS: type: string example: '13.141944' UNDER_500_MBPS: type: string example: '74.891763' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/duration: get: tags: - Radar summary: Cloudflare Get Attack Durations Summary description: Percentage distribution of attacks by duration. operationId: radar-get-attacks-layer3-summary-by-duration parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - UNDER_10_MINS - _10_MINS_TO_20_MINS - OVER_3_HOURS - _1_HOUR_TO_3_HOURS - _20_MINS_TO_40_MINS - _40_MINS_TO_1_HOUR properties: _1_HOUR_TO_3_HOURS: type: string example: '4.038413' _10_MINS_TO_20_MINS: type: string example: '9.48709' _20_MINS_TO_40_MINS: type: string example: '3.87624' _40_MINS_TO_1_HOUR: type: string example: '1.892012' OVER_3_HOURS: type: string example: '4.462923' UNDER_10_MINS: type: string example: '76.243322' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/ip_version: get: tags: - Radar summary: Cloudflare Get IP Versions Summary description: Percentage distribution of attacks by ip version used. operationId: radar-get-attacks-layer3-summary-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: '99.984766' IPv6: type: string example: '0.015234' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/protocol: get: tags: - Radar summary: Cloudflare Get Layer 3 Protocols Summary description: Percentage distribution of attacks by protocol used. operationId: radar-get-attacks-layer3-summary-by-protocol parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - TCP - UDP - GRE - ICMP properties: GRE: type: string example: '0.756379' ICMP: type: string example: '0.015245' TCP: type: string example: '82.89908' UDP: type: string example: '16.328986' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/summary/vector: get: tags: - Radar summary: Cloudflare Get Attack Vector Summary description: Percentage distribution of attacks by vector. operationId: radar-get-attacks-layer3-summary-by-vector parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object example: ACK Flood: - '65.662148' SYN Flood: - '16.86401' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries: get: tags: - Radar summary: Cloudflare Get Attacks By Bytes Summary description: Get attacks change over time by bytes. operationId: radar-get-attacks-layer3-timeseries-by-bytes parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE_CHANGE - MIN0_MAX example: MIN0_MAX - name: metric in: query schema: type: string description: Measurement units, eg. bytes. enum: - BYTES - BYTES_OLD default: bytes - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string values: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups: get: tags: - Radar summary: Cloudflare Get Layer 3 Attacks By Network Protocol Time Series description: >- Get a timeseries of the percentage distribution of network protocols in Layer 3/4 attacks. operationId: radar-get-attacks-layer3-timeseries-groups parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - udp - tcp - gre - icmp properties: gre: type: array items: type: string example: '0.9' icmp: type: array items: type: string example: '0.1' tcp: type: array items: type: string example: '70' timestamps: type: array items: type: string udp: type: array items: type: string example: '29' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/bitrate: get: tags: - Radar summary: Cloudflare Get Attacks By Bitrate Time Series description: Percentage distribution of attacks by bitrate over time. operationId: radar-get-attacks-layer3-timeseries-group-by-bitrate parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - UNDER_500_MBPS - OVER_100_GBPS - _1_GBPS_TO_10_GBPS - _500_MBPS_TO_1_GBPS - _10_GBPS_TO_100_GBPS properties: _1_GBPS_TO_10_GBPS: type: array items: type: string _10_GBPS_TO_100_GBPS: type: array items: type: string _500_MBPS_TO_1_GBPS: type: array items: type: string OVER_100_GBPS: type: array items: type: string UNDER_500_MBPS: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/duration: get: tags: - Radar summary: Cloudflare Get Layer 3 Attack By Duration Time Series description: Percentage distribution of attacks by duration over time. operationId: radar-get-attacks-layer3-timeseries-group-by-duration parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - UNDER_10_MINS - _10_MINS_TO_20_MINS - OVER_3_HOURS - _1_HOUR_TO_3_HOURS - _20_MINS_TO_40_MINS - _40_MINS_TO_1_HOUR properties: _1_HOUR_TO_3_HOURS: type: array items: type: string _10_MINS_TO_20_MINS: type: array items: type: string _20_MINS_TO_40_MINS: type: array items: type: string _40_MINS_TO_1_HOUR: type: array items: type: string OVER_3_HOURS: type: array items: type: string UNDER_10_MINS: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/industry: get: tags: - Radar summary: Cloudflare Get Layer 3 Attacks By Target Industries Time Series description: Percentage distribution of attacks by industry used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-industry parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: limitPerGroup in: query schema: type: integer description: >- Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet: - '5.519081' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/ip_version: get: tags: - Radar summary: Cloudflare Get Layer 3 Attacks By IP Version Time Series description: Percentage distribution of attacks by ip version used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - IPv4 - IPv6 properties: IPv4: type: array items: type: string IPv6: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/protocol: get: tags: - Radar summary: Cloudflare Get Layer 3 Attacks By Protocol Timeseries description: Percentage distribution of attacks by protocol used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-protocol parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - TCP - UDP - GRE - ICMP properties: GRE: type: array items: type: string ICMP: type: array items: type: string TCP: type: array items: type: string UDP: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/vector: get: tags: - Radar summary: Cloudflare Get Layer 3 Attacks By Vector description: Percentage distribution of attacks by vector used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-vector parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: limitPerGroup in: query schema: type: integer description: >- Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: ACK Flood: - '97.28898' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/timeseries_groups/vertical: get: tags: - Radar summary: Cloudflare Get Layer 3 Attacks By Vertical Time Series description: Percentage distribution of attacks by vertical used over time. operationId: radar-get-attacks-layer3-timeseries-group-by-vertical parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: direction in: query schema: type: string description: >- Together with the `location` parameter, will apply the filter to origin or target location. enum: - ORIGIN - TARGET default: ORIGIN - name: limitPerGroup in: query schema: type: integer description: >- Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet and Telecom: - '5.519081' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/attacks: get: tags: - Radar summary: Cloudflare Get top attack pairs (origin and target locations) of Layer 3 attacks description: >- Get the top attacks from origin to target location. Values are a percentage out of the total layer 3 attacks (with billing country). You can optionally limit the number of attacks per origin/target location (useful if all the top attacks are from or to the same location). operationId: radar-get-attacks-layer3-top-attacks parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: limitDirection in: query schema: type: string description: >- Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. enum: - ORIGIN - TARGET default: ORIGIN example: ORIGIN - name: limitPerLocation in: query schema: type: integer description: >- Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location. example: 10 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - value properties: originCountryAlpha2: type: string example: FR originCountryName: type: string example: France value: type: string example: '4.323214' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/industry: get: tags: - Radar summary: Cloudflare Get top Industry of attack description: Get the Industry of attacks. operationId: radar-get-attacks-layer3-top-industries parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: Computer Software value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/locations/origin: get: tags: - Radar summary: Cloudflare Get top origin locations of attack description: Get the origin locations of attacks. operationId: radar-get-attacks-layer3-top-origin-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - value - rank properties: originCountryAlpha2: type: string example: FR originCountryName: type: string example: France rank: type: number example: 1 value: type: string example: '4.323214' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/locations/target: get: tags: - Radar summary: Cloudflare Get top target locations of attack description: Get the target locations of attacks. operationId: radar-get-attacks-layer3-top-target-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - targetCountryAlpha2 - targetCountryName - value - rank properties: rank: type: number example: 1 targetCountryAlpha2: type: string example: FR targetCountryName: type: string example: France value: type: string example: '4.323214' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer3/top/vertical: get: tags: - Radar summary: Cloudflare Get top Verticals of attack description: Get the Verticals of attacks. operationId: radar-get-attacks-layer3-top-verticals parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: protocol in: query schema: type: array description: Array of L3/4 attack types. items: type: string enum: - UDP - TCP - ICMP - GRE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: Internet and Telecom value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks Summary description: Percentage distribution of mitigation techniques in Layer 7 attacks. operationId: radar-get-attacks-layer7-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' summary_0: type: object required: - WAF - DDOS - IP_REPUTATION - ACCESS_RULES - BOT_MANAGEMENT - API_SHIELD - DATA_LOSS_PREVENTION properties: ACCESS_RULES: type: string example: '0.9' API_SHIELD: type: string example: '0.9' BOT_MANAGEMENT: type: string example: '0.9' DATA_LOSS_PREVENTION: type: string example: '0.9' DDOS: type: string example: '34' IP_REPUTATION: type: string example: '0.1' WAF: type: string example: '65' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/http_method: get: tags: - Radar summary: Cloudflare Get HTTP Method Summary description: Percentage distribution of attacks by http method used. operationId: radar-get-attacks-layer7-summary-by-http-method parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - GET - POST properties: GET: type: string example: '99.100257' POST: type: string example: '0.899743' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/http_version: get: tags: - Radar summary: Cloudflare Get HTTP Version Summary description: Percentage distribution of attacks by http version used. operationId: radar-get-attacks-layer7-summary-by-http-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - HTTP/2 - HTTP/1.x - HTTP/3 properties: HTTP/1.x: type: string example: '21.722365' HTTP/2: type: string example: '77.056555' HTTP/3: type: string example: '1.22108' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/ip_version: get: tags: - Radar summary: Cloudflare Get Ip Version Summary description: Percentage distribution of attacks by ip version used. operationId: radar-get-attacks-layer7-summary-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: '99.935733' IPv6: type: string example: '0.064267' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/managed_rules: get: tags: - Radar summary: Cloudflare Get Managed Rules Summary description: Percentage distribution of attacks by managed rules used. operationId: radar-get-attacks-layer7-summary-by-managed-rules parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - HTTP Anomaly - Bot properties: Bot: type: string example: '14.285714' HTTP Anomaly: type: string example: '85.714286' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/summary/mitigation_product: get: tags: - Radar summary: Cloudflare Get Mitigation Product Summary description: Percentage distribution of attacks by mitigation product used. operationId: radar-get-attacks-layer7-summary-by-mitigation-product parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - WAF - DDOS properties: DDOS: type: string example: '24.421594' WAF: type: string example: '53.213368' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks Time Series description: >- Get a timeseries of Layer 7 attacks. Values represent HTTP requests and are normalized using min-max by default. operationId: radar-get-attacks-layer7-timeseries parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: attack in: query schema: type: array description: Array of L7 attack types. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE_CHANGE - MIN0_MAX example: MIN0_MAX - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By Mitigation Technique Time Series description: >- Get a time series of the percentual distribution of mitigation techniques, over time. operationId: radar-get-attacks-layer7-timeseries-group parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - WAF - DDOS - IP_REPUTATION - ACCESS_RULES - BOT_MANAGEMENT - API_SHIELD - DATA_LOSS_PREVENTION properties: ACCESS_RULES: type: array items: type: string example: '5' API_SHIELD: type: array items: type: string example: '5' BOT_MANAGEMENT: type: array items: type: string example: '5' DATA_LOSS_PREVENTION: type: array items: type: string example: '5' DDOS: type: array items: type: string example: '60' IP_REPUTATION: type: array items: type: string example: '5' WAF: type: array items: type: string example: '30' timestamps: type: array items: type: string format: date-time success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false deprecated: true security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/http_method: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By HTTP Method Time Series description: Percentage distribution of attacks by http method used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-http-method parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - GET properties: GET: type: array items: type: string example: '70.970199' timestamps: type: array items: type: string example: '2023-10-01T00:00:00Z' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/http_version: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By HTTP Version Time Series description: Percentage distribution of attacks by http version used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-http-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - HTTP/1.x properties: HTTP/1.x: type: array items: type: string example: '50.338734' timestamps: type: array items: type: string example: '2023-10-01T00:00:00Z' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/industry: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By Target Industries Time Series description: Percentage distribution of attacks by industry used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-industry parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: limitPerGroup in: query schema: type: integer description: >- Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet: - '5.519081' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/ip_version: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By IP Version Time Series description: Percentage distribution of attacks by ip version used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - IPv4 - IPv6 properties: IPv4: type: array items: type: string example: '99.935733' IPv6: type: array items: type: string example: '0.064267' timestamps: type: array items: type: string example: '2023-10-01T00:00:00Z' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/managed_rules: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By Managed Rules Time Series description: Percentage distribution of attacks by managed rules used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-managed-rules parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - Bot properties: Bot: type: array items: type: string example: '0.324198' timestamps: type: array items: type: string example: '2023-10-01T00:00:00Z' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/mitigation_product: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By Mitigation Product Time Series description: Percentage distribution of attacks by mitigation product used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-mitigation-product parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - DDOS properties: DDOS: type: array items: type: string example: '48.926354' timestamps: type: array items: type: string example: '2023-10-01T00:00:00Z' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/timeseries_groups/vertical: get: tags: - Radar summary: Cloudflare Get Layer 7 Attacks By Vertical Time Series description: Percentage distribution of attacks by vertical used over time. operationId: radar-get-attacks-layer7-timeseries-group-by-vertical parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: httpMethod in: query schema: type: array description: Filter for http method. example: GET items: type: string enum: - GET - POST - DELETE - PUT - HEAD - PURGE - OPTIONS - PROPFIND - MKCOL - PATCH - ACL - BCOPY - BDELETE - BMOVE - BPROPFIND - BPROPPATCH - CHECKIN - CHECKOUT - CONNECT - COPY - LABEL - LOCK - MERGE - MKACTIVITY - MKWORKSPACE - MOVE - NOTIFY - ORDERPATCH - POLL - PROPPATCH - REPORT - SEARCH - SUBSCRIBE - TRACE - UNCHECKOUT - UNLOCK - UNSUBSCRIBE - UPDATE - VERSIONCONTROL - BASELINECONTROL - XMSENUMATTS - RPC_OUT_DATA - RPC_IN_DATA - JSON - COOK - TRACK - name: mitigationProduct in: query schema: type: array description: Array of L7 mitigation products. items: type: string enum: - DDOS - WAF - BOT_MANAGEMENT - ACCESS_RULES - IP_REPUTATION - API_SHIELD - DATA_LOSS_PREVENTION - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE - MIN0_MAX default: PERCENTAGE example: PERCENTAGE - name: limitPerGroup in: query schema: type: integer description: >- Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Internet and Telecom: - '5.519081' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/ases/origin: get: tags: - Radar summary: Cloudflare Get Top Origin Autonomous Systems By Layer 7 Attacks description: >- Get the top origin Autonomous Systems of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin Autonomous Systems is determined by the client IP. operationId: radar-get-attacks-layer7-top-origin-as parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - originAsnName - originAsn - value - rank properties: originAsn: type: string example: '55836' originAsnName: type: string example: RELIANCEJIO-IN Reliance Jio Infocomm Limited rank: type: number example: 1 value: type: string example: '4.323214' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/attacks: get: tags: - Radar summary: Cloudflare Get Top Attack Pairs (origin and target locations) By Layer 7 Attacks description: >- Get the top attacks from origin to target location. Values are a percentage out of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks per origin/target location (useful if all the top attacks are from or to the same location). operationId: radar-get-attacks-layer7-top-attacks parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: limitDirection in: query schema: type: string description: >- Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. enum: - ORIGIN - TARGET default: ORIGIN example: ORIGIN - name: limitPerLocation in: query schema: type: integer description: >- Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location. example: 10 - name: magnitude in: query schema: type: string description: >- Attack magnitude can be defined by total requests mitigated or by total zones attacked. enum: - AFFECTED_ZONES - MITIGATED_REQUESTS example: MITIGATED_REQUESTS - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - targetCountryAlpha2 - targetCountryName - value properties: originCountryAlpha2: type: string example: US originCountryName: type: string example: United States targetCountryAlpha2: type: string example: FR targetCountryName: type: string example: France value: type: string example: '4.323214' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/industry: get: tags: - Radar summary: Cloudflare Get top Industry of attack description: Get the Industry of attacks. operationId: radar-get-attacks-layer7-top-industries parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: Computer Software value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/locations/origin: get: tags: - Radar summary: Cloudflare Get Top Origin Locations By Layer 7 Attacks description: >- Get the top origin locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP. operationId: radar-get-attacks-layer7-top-origin-location parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - originCountryAlpha2 - originCountryName - value - rank properties: originCountryAlpha2: type: string example: FR originCountryName: type: string example: France rank: type: number example: 1 value: type: string example: '4.323214' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/locations/target: get: tags: - Radar summary: Cloudflare Get layer 7 top target locations description: >- Get the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available. operationId: radar-get-attacks-layer7-top-target-location parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - targetCountryAlpha2 - targetCountryName - value - rank properties: rank: type: number example: 1 targetCountryAlpha2: type: string example: FR targetCountryName: type: string example: France value: type: string example: '4.323214' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/attacks/layer7/top/vertical: get: tags: - Radar summary: Cloudflare Get top Verticals of attack description: Get the Verticals of attacks. operationId: radar-get-attacks-layer7-top-verticals parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: Internet and Telecom value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/bgp/hijacks/events: get: tags: - Radar summary: Cloudflare Get BGP hijack events description: Get the BGP hijack events. (Beta) operationId: radar-get-bgp-hijacks-events parameters: - name: page in: query schema: type: integer description: Current page number, starting from 1 - name: per_page in: query schema: type: integer description: Number of entries per page - name: eventId in: query schema: type: integer description: The unique identifier of a event - name: hijackerAsn in: query schema: type: integer description: The potential hijacker AS of a BGP hijack event - name: victimAsn in: query schema: type: integer description: The potential victim AS of a BGP hijack event - name: involvedAsn in: query schema: type: integer description: The potential hijacker or victim AS of a BGP hijack event - name: involvedCountry in: query schema: type: string description: >- The country code of the potential hijacker or victim AS of a BGP hijack event - name: prefix in: query schema: type: string description: The prefix hijacked during a BGP hijack event - name: minConfidence in: query schema: type: integer description: >- The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) - name: maxConfidence in: query schema: type: integer description: >- The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) - name: dateRange in: query schema: type: string description: >- Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: sortBy in: query schema: type: string description: Sort events by field enum: - ID - TIME - CONFIDENCE example: TIME - name: sortOrder in: query schema: type: string description: Sort order enum: - ASC - DESC example: DESC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - result_info - success properties: result: type: object required: - asn_info - events - total_monitors properties: asn_info: type: array items: type: object required: - asn - org_name - country_code properties: asn: type: integer country_code: type: string org_name: type: string events: type: array items: type: object 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 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: type: object required: - name - score properties: name: type: string score: type: integer victim_asns: type: array items: type: integer victim_countries: type: array items: type: string total_monitors: type: integer result_info: type: object required: - count - total_count - page - per_page properties: count: type: integer page: type: integer per_page: type: integer total_count: type: integer success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/leaks/events: get: tags: - Radar summary: Cloudflare Get BGP route leak events description: Get the BGP route leak events (Beta). operationId: radar-get-bgp-route-leak-events parameters: - name: page in: query schema: type: integer description: Current page number, starting from 1 - name: per_page in: query schema: type: integer description: Number of entries per page - name: eventId in: query schema: type: integer description: The unique identifier of a event - name: leakAsn in: query schema: type: integer description: The leaking AS of a route leak event - name: involvedAsn in: query schema: type: integer description: ASN that is causing or affected by a route leak event - name: involvedCountry in: query schema: type: string description: Country code of a involved ASN in a route leak event - name: dateRange in: query schema: type: string description: >- Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: sortBy in: query schema: type: string description: Sort events by field enum: - ID - LEAKS - PEERS - PREFIXES - ORIGINS - TIME example: TIME - name: sortOrder in: query schema: type: string description: Sort order enum: - ASC - DESC example: DESC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - result_info - success properties: result: type: object required: - asn_info - events properties: asn_info: type: array items: type: object required: - asn - org_name - country_code properties: asn: type: integer country_code: type: string org_name: type: string events: type: array items: type: object required: - detected_ts - finished - id - leak_asn - leak_count - leak_seg - leak_type - max_ts - min_ts - origin_count - peer_count - prefix_count - countries 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 result_info: type: object required: - count - total_count - page - per_page properties: count: type: integer page: type: integer per_page: type: integer total_count: type: integer success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/moas: get: tags: - Radar summary: Cloudflare Get MOASes description: List all Multi-origin AS (MOAS) prefixes on the global routing tables. operationId: radar-get-bgp-pfx2as-moas parameters: - name: origin in: query schema: type: integer description: Lookup MOASes originated by the given ASN - name: prefix in: query schema: type: string description: Lookup MOASes by prefix - name: invalid_only in: query schema: type: boolean description: Lookup only RPKI invalid MOASes - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - moas - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer moas: type: array items: type: object required: - prefix - origins properties: origins: type: array items: type: object required: - origin - peer_count - rpki_validation properties: origin: type: integer peer_count: type: integer rpki_validation: type: string prefix: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/pfx2as: get: tags: - Radar summary: Cloudflare Get prefix-to-origin mapping description: Lookup prefix-to-origin mapping on global routing tables. operationId: radar-get-bgp-pfx2as parameters: - name: origin in: query schema: type: integer description: Lookup prefixes originated by the given ASN - name: prefix in: query schema: type: string description: Lookup origins of the given prefix example: 1.1.1.0/24 - name: rpkiStatus in: query schema: type: string description: >- Return only results with matching rpki status: valid, invalid or unknown enum: - VALID - INVALID - UNKNOWN example: INVALID - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - prefix_origins - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer prefix_origins: type: array items: type: object required: - origin - peer_count - prefix - rpki_validation properties: origin: type: integer peer_count: type: integer prefix: type: string rpki_validation: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/stats: get: tags: - Radar summary: 'Cloudflare Get BGP routing table stats' description: Get the BGP routing table stats (Beta). operationId: radar-get-bgp-routes-stats parameters: - name: asn in: query schema: type: integer description: Single ASN as integer. example: '174' - name: location in: query schema: type: string description: Location Alpha2 code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - stats - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer stats: type: object 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 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 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/routes/timeseries: get: tags: - Radar summary: Cloudflare Get BGP IP space time series description: >- Gets time-series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN. operationId: radar-get-bgp-ip-space-timeseries parameters: - name: dateRange in: query schema: type: string description: >- Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: asn in: query schema: type: integer description: Single ASN as integer. example: '174' - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_ipv4_24s - serie_ipv6_48s properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' serie_ipv4_24s: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: integer example: 30 serie_ipv6_48s: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: integer example: 1234 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/timeseries: get: tags: - Radar summary: Cloudflare Get BGP time series description: >- Gets BGP updates change over time. Raw values are returned. When requesting updates of an autonomous system (AS), only BGP updates of type announcement are returned. operationId: radar-get-bgp-timeseries parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: prefix in: query schema: type: array description: Array of BGP network prefixes. example: 1.1.1.0/24 items: type: string - name: updateType in: query schema: type: array description: Array of BGP update types. example: ANNOUNCEMENT items: type: string enum: - ANNOUNCEMENT - WITHDRAWAL - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/top/ases: get: tags: - Radar summary: Cloudflare Get top autonomous systems description: >- Get the top autonomous systems (AS) by BGP updates (announcements only). Values are a percentage out of the total updates. operationId: radar-get-bgp-top-ases parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: prefix in: query schema: type: array description: Array of BGP network prefixes. example: 1.1.1.0/24 items: type: string - name: updateType in: query schema: type: array description: Array of BGP update types. example: ANNOUNCEMENT items: type: string enum: - ANNOUNCEMENT - WITHDRAWAL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' top_0: type: array items: type: object required: - asn - ASName - value properties: ASName: type: string example: Apple-Engineering asn: type: integer example: 714 value: type: string description: >- Percentage of updates by this AS out of the total updates by all autonomous systems. example: '0.73996' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/bgp/top/ases/prefixes: get: tags: - Radar summary: Cloudflare Get list of ASNs ordered by prefix count description: >- Get 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. operationId: radar-get-bgp-top-asns-by-prefixes parameters: - name: country in: query schema: type: string description: Alpha-2 country code. example: NZ - name: limit in: query schema: type: integer description: Maximum number of ASes to return example: 10 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asns - meta properties: asns: type: array items: type: object required: - asn - country - name - pfxs_count properties: asn: type: integer country: type: string name: type: string pfxs_count: type: integer meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/bgp/top/prefixes: get: tags: - Radar summary: Cloudflare Get top prefixes description: >- Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates. operationId: radar-get-bgp-top-prefixes parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: updateType in: query schema: type: array description: Array of BGP update types. example: ANNOUNCEMENT items: type: string enum: - ANNOUNCEMENT - WITHDRAWAL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' top_0: type: array items: type: object required: - prefix - value properties: prefix: type: string example: 2804:77cc:8000::/33 value: type: string example: '0.73996' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/connection_tampering/summary: get: tags: - Radar summary: Cloudflare Get Connection Tampering Summary description: Distribution of connection tampering types over a given time period. operationId: radar-get-connection-tampering-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' summary_0: type: object required: - no_match - post_syn - post_ack - post_psh - later_in_flow properties: later_in_flow: type: string description: >- Connections matching signatures for tampering later in the connection, after the transfer of multiple data packets. example: '10' no_match: type: string description: >- Connections that do not match any tampering signatures. example: '65' post_ack: type: string description: >- Connections matching signatures for tampering after the receipt of a SYN packet and ACK packet, meaning the TCP connection was successfully established but the server did not receive any subsequent packets. example: '5' post_psh: type: string description: >- Connections matching signatures for tampering after the receipt of a packet with PSH flag set, following connection establishment. example: '10' post_syn: type: string description: >- Connections matching signatures for tampering after the receipt of only a single SYN packet, and before the handshake completes. example: '10' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/connection_tampering/timeseries_groups: get: tags: - Radar summary: Cloudflare Get Connection Tampering Time Series description: Distribution of connection tampering types over time. operationId: radar-get-connection-tampering-timeseries-group parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - no_match - post_syn - post_ack - post_psh - later_in_flow properties: later_in_flow: type: array description: >- Connections matching signatures for tampering later in the connection, after the transfer of multiple data packets. items: type: string description: >- Connections matching signatures for tampering later in the connection, after the transfer of multiple data packets. example: '10' no_match: type: array description: >- Connections that do not match any tampering signatures. items: type: string description: >- Connections that do not match any tampering signatures. example: '65' post_ack: type: array description: >- Connections matching signatures for tampering after the receipt of a SYN packet and ACK packet, meaning the TCP connection was successfully established but the server did not receive any subsequent packets. items: type: string description: >- Connections matching signatures for tampering after the receipt of a SYN packet and ACK packet, meaning the TCP connection was successfully established but the server did not receive any subsequent packets. example: '5' post_psh: type: array description: >- Connections matching signatures for tampering after the receipt of a packet with PSH flag set, following connection establishment. items: type: string description: >- Connections matching signatures for tampering after the receipt of a packet with PSH flag set, following connection establishment. example: '10' post_syn: type: array description: >- Connections matching signatures for tampering after the receipt of only a single SYN packet, and before the handshake completes. items: type: string description: >- Connections matching signatures for tampering after the receipt of only a single SYN packet, and before the handshake completes. example: '10' timestamps: type: array items: type: string format: date-time success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/datasets: get: tags: - Radar summary: Cloudflare Get Datasets description: Get a list of datasets. operationId: radar-get-reports-datasets parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: datasetType in: query schema: type: string description: Dataset type. enum: - RANKING_BUCKET - REPORT default: RANKING_BUCKET example: RANKING_BUCKET - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - datasets properties: datasets: type: array items: type: object required: - id - title - description - type - tags - meta properties: description: type: string example: >- This dataset contains a list of the op 20000 domains globally id: type: integer example: 3 meta: type: object tags: type: array items: type: string example: global title: type: string example: Top bucket 20000 domains type: type: string example: RANKING_BUCKET success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/datasets/{alias}: get: tags: - Radar summary: Cloudflare Get Dataset csv Stream description: >- Get the csv content of a given dataset by alias or id. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date. operationId: radar-get-reports-dataset-download parameters: - name: alias in: path required: true schema: type: string description: Dataset alias or id example: ranking_top_1000 - name: date in: query schema: type: string description: Filter dataset alias by date nullable: true responses: '200': description: Successful Response content: text/csv: schema: type: string '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/datasets/download: post: tags: - Radar summary: Cloudflare Get Dataset download url description: Get a url to download a single dataset. operationId: radar-post-reports-dataset-download-url parameters: - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json requestBody: content: application/json: schema: type: object required: - datasetId properties: datasetId: type: integer example: 3 responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - dataset properties: dataset: type: object required: - url properties: url: type: string example: https://example.com/download success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/dns/top/ases: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems by DNS queries. description: >- Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver. operationId: radar-get-dns-top-ases parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: domain in: query required: true schema: type: array description: Array of domain names. example: google.com items: type: string pattern: >- ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$ - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 174 clientASName: type: string example: Cogent-174 value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/dns/top/locations: get: tags: - Radar summary: Cloudflare Get Top Locations by DNS queries description: >- Get top locations by DNS queries made to Cloudflare's public DNS resolver. operationId: radar-get-dns-top-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: domain in: query required: true schema: type: array description: Array of domain names. example: google.com items: type: string pattern: >- ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$ - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: PT clientCountryName: type: string example: Portugal value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/arc: get: tags: - Radar summary: Cloudflare Get ARC Validations Summary description: Percentage distribution of emails classified per ARC validation. operationId: radar-get-email-routing-summary-by-arc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/dkim: get: tags: - Radar summary: Cloudflare Get DKIM Validations Summary description: Percentage distribution of emails classified per DKIM validation. operationId: radar-get-email-routing-summary-by-dkim parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/dmarc: get: tags: - Radar summary: Cloudflare Get DMARC Validations Summary description: Percentage distribution of emails classified per DMARC validation. operationId: radar-get-email-routing-summary-by-dmarc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/encrypted: get: tags: - Radar summary: Cloudflare Get Encrypted Summary description: Percentage distribution of emails by Encrypted operationId: radar-get-email-routing-summary-by-encrypted parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - ENCRYPTED - NOT_ENCRYPTED properties: ENCRYPTED: type: string example: '65' NOT_ENCRYPTED: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/ip_version: get: tags: - Radar summary: Cloudflare Get Ip Version Summary description: Percentage distribution of emails by Ip Version. operationId: radar-get-email-routing-summary-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: '65' IPv6: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/summary/spf: get: tags: - Radar summary: Cloudflare Get SPF Validations Summary description: Percentage distribution of emails classified per SPF validation. operationId: radar-get-email-routing-summary-by-spf parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/arc: get: tags: - Radar summary: Cloudflare Get ARC Validations Time Series description: >- Percentage distribution of emails classified per Arc validation over time. operationId: radar-get-email-routing-timeseries-group-by-arc parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/dkim: get: tags: - Radar summary: Cloudflare Get DKIM Validations Time Series description: >- Percentage distribution of emails classified per DKIM validation over time. operationId: radar-get-email-routing-timeseries-group-by-dkim parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/dmarc: get: tags: - Radar summary: Cloudflare Get DMARC Validations Time Series description: >- Percentage distribution of emails classified per DMARC validation over time. operationId: radar-get-email-routing-timeseries-group-by-dmarc parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/encrypted: get: tags: - Radar summary: Cloudflare Get Encrypted Time Series description: Percentage distribution of emails by Encrypted over time. operationId: radar-get-email-routing-timeseries-group-by-encrypted parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - ENCRYPTED - NOT_ENCRYPTED properties: ENCRYPTED: type: array items: type: string example: '65' NOT_ENCRYPTED: type: array items: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/ip_version: get: tags: - Radar summary: Cloudflare Get Ip Version Time Series description: Percentage distribution of emails by Ip Version over time. operationId: radar-get-email-routing-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: array items: type: string example: '65' IPv6: type: array items: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/routing/timeseries_groups/spf: get: tags: - Radar summary: Cloudflare Get SPF Validations Time Series description: >- Percentage distribution of emails classified per SPF validation over time. operationId: radar-get-email-routing-timeseries-group-by-spf parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: encrypted in: query schema: type: array description: Filter for encrypted emails. example: ENCRYPTED items: type: string enum: - ENCRYPTED - NOT_ENCRYPTED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/arc: get: tags: - Radar summary: Cloudflare Get ARC Validations Summary description: Percentage distribution of emails classified per ARC validation. operationId: radar-get-email-security-summary-by-arc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/dkim: get: tags: - Radar summary: Cloudflare Get DKIM Validations Summary description: Percentage distribution of emails classified per DKIM validation. operationId: radar-get-email-security-summary-by-dkim parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/dmarc: get: tags: - Radar summary: Cloudflare Get DMARC Validations Summary description: Percentage distribution of emails classified per DMARC validation. operationId: radar-get-email-security-summary-by-dmarc parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/malicious: get: tags: - Radar summary: Cloudflare Get MALICIOUS Validations Summary description: Percentage distribution of emails classified as MALICIOUS. operationId: radar-get-email-security-summary-by-malicious parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - MALICIOUS - NOT_MALICIOUS properties: MALICIOUS: type: string example: '65' NOT_MALICIOUS: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/spam: get: tags: - Radar summary: Cloudflare Get SPAM Summary description: >- Proportion of emails categorized as either spam or legitimate (non-spam). operationId: radar-get-email-security-summary-by-spam parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - SPAM - NOT_SPAM properties: NOT_SPAM: type: string example: '35' SPAM: type: string example: '65' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/spf: get: tags: - Radar summary: Cloudflare Get SPF Validations Summary description: Percentage distribution of emails classified per SPF validation. operationId: radar-get-email-security-summary-by-spf parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: string example: '2' NONE: type: string example: '53' PASS: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/spoof: get: tags: - Radar summary: Cloudflare Get SPOOF Summary description: >- Proportion of emails categorized as either spoof or legitimate (non-spoof). operationId: radar-get-email-security-summary-by-spoof parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - SPOOF - NOT_SPOOF properties: NOT_SPOOF: type: string example: '35' SPOOF: type: string example: '65' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/threat_category: get: tags: - Radar summary: Cloudflare Get Threat Categories Summary description: Percentage distribution of emails classified in Threat Categories. operationId: radar-get-email-security-summary-by-threat-category parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - IdentityDeception - Link - BrandImpersonation - CredentialHarvester properties: BrandImpersonation: type: string example: '35' CredentialHarvester: type: string example: '32' IdentityDeception: type: string example: '47' Link: type: string example: '43' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/summary/tls_version: get: tags: - Radar summary: Cloudflare Get TLS Version Summary description: Percentage distribution of emails classified per TLS Version. operationId: radar-get-email-security-summary-by-tls-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 properties: TLS 1.0: type: string example: '3' TLS 1.1: type: string example: '12' TLS 1.2: type: string example: '41' TLS 1.3: type: string example: '44' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/arc: get: tags: - Radar summary: Cloudflare Get ARC Validations Time Series description: >- Percentage distribution of emails classified per Arc validation over time. operationId: radar-get-email-security-timeseries-group-by-arc parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/dkim: get: tags: - Radar summary: Cloudflare Get DKIM Validations Time Series description: >- Percentage distribution of emails classified per DKIM validation over time. operationId: radar-get-email-security-timeseries-group-by-dkim parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/dmarc: get: tags: - Radar summary: Cloudflare Get DMARC Validations Time Series description: >- Percentage distribution of emails classified per DMARC validation over time. operationId: radar-get-email-security-timeseries-group-by-dmarc parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/malicious: get: tags: - Radar summary: Cloudflare Get MALICIOUS Validations Time Series description: Percentage distribution of emails classified as MALICIOUS over time. operationId: radar-get-email-security-timeseries-group-by-malicious parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - MALICIOUS - NOT_MALICIOUS properties: MALICIOUS: type: array items: type: string example: '65' NOT_MALICIOUS: type: array items: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/spam: get: tags: - Radar summary: Cloudflare Get SPAM Validations Time Series description: Percentage distribution of emails classified as SPAM over time. operationId: radar-get-email-security-timeseries-group-by-spam parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SPAM - NOT_SPAM properties: NOT_SPAM: type: array items: type: string example: '35' SPAM: type: array items: type: string example: '65' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/spf: get: tags: - Radar summary: Cloudflare Get SPF Validations Time Series description: >- Percentage distribution of emails classified per SPF validation over time. operationId: radar-get-email-security-timeseries-group-by-spf parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - NONE - PASS - FAIL properties: FAIL: type: array items: type: string example: '2' NONE: type: array items: type: string example: '53' PASS: type: array items: type: string example: '45' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/spoof: get: tags: - Radar summary: Cloudflare Get SPOOF Validations Time Series description: Percentage distribution of emails classified as SPOOF over time. operationId: radar-get-email-security-timeseries-group-by-spoof parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - SPOOF - NOT_SPOOF properties: NOT_SPOOF: type: array items: type: string example: '35' SPOOF: type: array items: type: string example: '65' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/threat_category: get: tags: - Radar summary: Cloudflare Get Threat Categories Time Series description: >- Percentage distribution of emails classified in Threat Categories over time. operationId: radar-get-email-security-timeseries-group-by-threat-category parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - IdentityDeception - Link - BrandImpersonation - CredentialHarvester properties: BrandImpersonation: type: array items: type: string example: '35' CredentialHarvester: type: array items: type: string example: '32' IdentityDeception: type: array items: type: string example: '47' Link: type: array items: type: string example: '43' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/timeseries_groups/tls_version: get: tags: - Radar summary: Cloudflare Get TLS Version Time Series description: Percentage distribution of emails classified per TLS Version over time. operationId: radar-get-email-security-timeseries-group-by-tls-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 properties: TLS 1.0: type: array items: type: string example: '3' TLS 1.1: type: array items: type: string example: '12' TLS 1.2: type: array items: type: string example: '41' TLS 1.3: type: array items: type: string example: '44' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds: get: tags: - Radar summary: Cloudflare Get Top TLDs By Email Messages description: >- Get the top TLDs by email messages. Values are a percentage out of the total emails. operationId: radar-get-email-security-top-tlds-by-messages parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds/malicious/{malicious}: get: tags: - Radar summary: Cloudflare Get Top TLDs By Malicious Classification description: Get the TLDs by emails classified as malicious or not. operationId: radar-get-email-security-top-tlds-by-malicious parameters: - name: malicious in: path required: true schema: type: string description: Malicious. enum: - MALICIOUS - NOT_MALICIOUS example: MALICIOUS - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds/spam/{spam}: get: tags: - Radar summary: Cloudflare Get Top TLDs By Spam Classification description: Get the top TLDs by emails classified as Spam or not. operationId: radar-get-email-security-top-tlds-by-spam parameters: - name: spam in: path required: true schema: type: string description: Spam. enum: - SPAM - NOT_SPAM example: SPAM - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/email/security/top/tlds/spoof/{spoof}: get: tags: - Radar summary: Cloudflare Get Top TLDs By Spoof Classification description: Get the TLDs by emails classified as spoof or not. operationId: radar-get-email-security-top-tlds-by-spoof parameters: - name: spoof in: path required: true schema: type: string description: Spoof. enum: - SPOOF - NOT_SPOOF example: SPOOF - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: arc in: query schema: type: array description: Filter for arc (Authenticated Received Chain). example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dkim in: query schema: type: array description: Filter for dkim. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: dmarc in: query schema: type: array description: Filter for dmarc. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: spf in: query schema: type: array description: Filter for spf. example: PASS items: type: string enum: - PASS - NONE - FAIL - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - name: tldCategory in: query schema: type: string description: Filter for TLDs by category. enum: - CLASSIC - COUNTRY example: CLASSIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: com. value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns: get: tags: - Radar summary: Cloudflare Get autonomous systems description: Gets a list of autonomous systems (AS). operationId: radar-get-entities-asn-list parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: asn in: query schema: type: string description: Comma separated list of ASNs. example: 174,7922 - name: location in: query schema: type: string description: Location Alpha2 to filter results. example: US - name: orderBy in: query schema: type: string description: Order asn list. enum: - ASN - POPULATION default: ASN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asns properties: asns: type: array items: type: object required: - name - asn - country - countryName properties: aka: type: string asn: type: integer example: 714 country: type: string example: GB countryName: type: string example: United Kingdom name: type: string example: Apple Inc. nameLong: type: string description: Deprecated field. Please use 'aka'. orgName: type: string website: type: string example: https://www.apple.com/support/systemstatus/ success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns/{asn}: get: tags: - Radar summary: Cloudflare Get autonomous system information by AS number description: >- Get the requested autonomous system information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). operationId: radar-get-entities-asn-by-id parameters: - name: asn in: path required: true schema: type: integer description: Autonomous System Number (ASN). example: 3 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asn properties: asn: type: object required: - name - country - countryName - confidenceLevel - related - source - asn - website - orgName - estimatedUsers properties: aka: type: string asn: type: integer example: 714 confidenceLevel: type: integer example: 5 country: type: string example: GB countryName: type: string example: United Kingdom estimatedUsers: type: object required: - locations properties: estimatedUsers: type: integer description: Total estimated users example: 86099 locations: type: array items: type: object required: - locationName - locationAlpha2 properties: estimatedUsers: type: integer description: Estimated users per location example: 16710 locationAlpha2: type: string example: US locationName: type: string example: United States name: type: string example: Apple Inc. nameLong: type: string description: Deprecated field. Please use 'aka'. orgName: type: string related: type: array items: type: object required: - name - asn properties: aka: type: string asn: type: integer example: 174 estimatedUsers: type: integer description: Total estimated users example: 65345 name: type: string example: Cogent-174 source: type: string description: Regional Internet Registry example: RIPE website: type: string example: https://www.apple.com/support/systemstatus/ success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns/{asn}/rel: get: tags: - Radar summary: Cloudflare Get AS-level relationships by AS number description: Get AS-level relationship for given networks. operationId: radar-get-asns-rel parameters: - name: asn in: path required: true schema: type: integer description: >- Get all ASNs with provider-customer or peering relationships with the given ASN example: 3 - name: asn2 in: query schema: type: integer description: Get the AS relationship of ASN2 with respect to the given ASN - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - rels - meta properties: meta: type: object required: - data_time - query_time - total_peers properties: data_time: type: string query_time: type: string total_peers: type: integer rels: type: array items: type: object required: - asn1 - asn1_country - asn1_name - asn2 - asn2_country - asn2_name - rel properties: asn1: type: integer asn1_country: type: string asn1_name: type: string asn2: type: integer asn2_country: type: string asn2_name: type: string rel: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/entities/asns/ip: get: tags: - Radar summary: Cloudflare Get autonomous system information by IP address description: >- Get the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). operationId: radar-get-entities-asn-by-ip parameters: - name: ip in: query required: true schema: type: string description: IP address. example: 8.8.8.8 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - asn properties: asn: type: object required: - name - country - countryName - related - asn - website - orgName - source - estimatedUsers properties: aka: type: string asn: type: integer example: 714 country: type: string example: GB countryName: type: string example: United Kingdom estimatedUsers: type: object required: - locations properties: estimatedUsers: type: integer description: Total estimated users example: 86099 locations: type: array items: type: object required: - locationName - locationAlpha2 properties: estimatedUsers: type: integer description: Estimated users per location example: 16710 locationAlpha2: type: string example: US locationName: type: string example: United States name: type: string example: Apple Inc. nameLong: type: string description: Deprecated field. Please use 'aka'. orgName: type: string related: type: array items: type: object required: - name - asn properties: aka: type: string asn: type: integer estimatedUsers: type: integer description: Total estimated users example: 65345 name: type: string source: type: string description: Regional Internet Registry example: RIPE website: type: string example: https://www.apple.com/support/systemstatus/ success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/ip: get: tags: - Radar summary: Cloudflare Get IP address description: 'Get IP address information. ' operationId: radar-get-entities-ip parameters: - name: ip in: query required: true schema: type: string description: IP address. example: 8.8.8.8 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - ip properties: ip: type: object required: - ip - ipVersion - location - locationName - asn - asnName - asnLocation - asnOrgName properties: asn: type: string example: '15169' asnLocation: type: string example: US asnName: type: string example: GOOGLE asnOrgName: type: string example: Google LLC ip: type: string example: 8.8.8.8 ipVersion: type: string example: IPv4 location: type: string example: GB locationName: type: string example: United Kingdom success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/entities/locations: get: tags: - Radar summary: Cloudflare Get locations description: Get a list of locations. operationId: radar-get-entities-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: location in: query schema: type: string description: Comma separated list of locations. example: US,CA - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - locations properties: locations: type: array items: type: object required: - name - latitude - longitude - alpha2 properties: alpha2: type: string example: AF latitude: type: string example: 33.939116 longitude: type: string example: 67.709953 name: type: string example: Afghanistan success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/entities/locations/{location}: get: tags: - Radar summary: Cloudflare Get location description: >- Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location). operationId: radar-get-entities-location-by-alpha2 parameters: - name: location in: path required: true schema: type: string description: Alpha-2 country code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - location properties: location: type: object required: - name - region - subregion - latitude - longitude - alpha2 - confidenceLevel properties: alpha2: type: string example: AF confidenceLevel: type: integer example: 5 latitude: type: string example: 33.939116 longitude: type: string example: 67.709953 name: type: string example: Afghanistan region: type: string example: Middle East subregion: type: string example: Southern Asia success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/bot_class: get: tags: - Radar summary: Cloudflare Get Bot Class Summary description: >- Percentage distribution of bot-generated traffic to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information. operationId: radar-get-http-summary-by-bot-class parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - human - bot properties: bot: type: string example: '35' human: type: string example: '65' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/device_type: get: tags: - Radar summary: Cloudflare Get Device Type Summary description: >- Percentage of Internet traffic generated by mobile, desktop, and other types of devices, over a given time period. operationId: radar-get-http-summary-by-device-type parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - desktop - mobile - other properties: desktop: type: string example: '65' mobile: type: string example: '30' other: type: string example: '5' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/http_protocol: get: tags: - Radar summary: Cloudflare Get HTTP protocols summary description: >- Percentage distribution of traffic per HTTP protocol over a given time period. operationId: radar-get-http-summary-by-http-protocol parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - http - https properties: http: type: string example: '99' https: type: string example: '1' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/http_version: get: tags: - Radar summary: Cloudflare Get HTTP Versions Summary description: >- Percentage distribution of traffic per HTTP protocol version over a given time period. operationId: radar-get-http-summary-by-http-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - HTTP/1.x - HTTP/2 - HTTP/3 properties: HTTP/1.x: type: string example: '1' HTTP/2: type: string example: '39' HTTP/3: type: string example: '60' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/ip_version: get: tags: - Radar summary: Cloudflare Get IP Version Summary description: >- Percentage distribution of Internet traffic based on IP protocol versions, such as IPv4 and IPv6, over a given time period. operationId: radar-get-http-summary-by-ip-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - IPv4 - IPv6 properties: IPv4: type: string example: '65' IPv6: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/os: get: tags: - Radar summary: Cloudflare Get Operating Systems Summary description: >- Percentage distribution of Internet traffic generated by different operating systems like Windows, macOS, Android, iOS, and others, over a given time period. operationId: radar-get-http-summary-by-operating-system parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - ANDROID - IOS properties: ANDROID: type: string example: '65' IOS: type: string example: '35' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/summary/tls_version: get: tags: - Radar summary: Cloudflare Get TLS Versions Summary description: >- Percentage distribution of traffic per TLS protocol version, over a given time period. operationId: radar-get-http-summary-by-tls-version parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 - TLS QUIC properties: TLS 1.0: type: string example: '0.5' TLS 1.1: type: string example: '0.5' TLS 1.2: type: string example: '60' TLS 1.3: type: string example: '10' TLS QUIC: type: string example: '29' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/bot_class: get: tags: - Radar summary: Cloudflare Get Bot Classes Time Series description: >- Get a time series of the percentage distribution of traffic classified as automated or human. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information. operationId: radar-get-http-timeseries-group-by-bot-class parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - human - bot properties: bot: type: array items: type: string human: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/browser: get: tags: - Radar summary: Cloudflare Get User Agents Time Series description: >- Get a time series of the percentage distribution of traffic of the top user agents. operationId: radar-get-http-timeseries-group-by-browsers parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: limitPerGroup in: query schema: type: integer description: >- Limit the number of objects (eg browsers, verticals, etc) to the top items over the time range. example: 4 - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Chrome: - '50.168733' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/browser_family: get: tags: - Radar summary: Cloudflare Get User Agent Families Time Series description: >- Get a time series of the percentage distribution of traffic of the top user agents aggregated in families. operationId: radar-get-http-timeseries-group-by-browser-families parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: Chrome: - '50.168733' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/device_type: get: tags: - Radar summary: Cloudflare Get Device Types Time Series description: >- Get a time series of the percentage distribution of traffic per device type. operationId: radar-get-http-timeseries-group-by-device-type parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - desktop - mobile - other properties: desktop: type: array items: type: string mobile: type: array items: type: string other: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/http_protocol: get: tags: - Radar summary: Cloudflare Get HTTP protocols Time Series description: >- Get a time series of the percentage distribution of traffic per HTTP protocol. operationId: radar-get-http-timeseries-group-by-http-protocol parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - http - https properties: http: type: array items: type: string https: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/http_version: get: tags: - Radar summary: Cloudflare Get HTTP Versions Time Series description: >- Get a time series of the percentage distribution of traffic per HTTP protocol version. operationId: radar-get-http-timeseries-group-by-http-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - HTTP/1.x - HTTP/2 - HTTP/3 properties: HTTP/1.x: type: array items: type: string HTTP/2: type: array items: type: string HTTP/3: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/ip_version: get: tags: - Radar summary: Cloudflare Get IP Versions Time Series description: >- Get a time series of the percentage distribution of traffic per IP protocol version. operationId: radar-get-http-timeseries-group-by-ip-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - IPv4 - IPv6 properties: IPv4: type: array items: type: string IPv6: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/os: get: tags: - Radar summary: Cloudflare Get Operating Systems Time Series description: >- Get a time series of the percentage distribution of traffic of the top operating systems. operationId: radar-get-http-timeseries-group-by-operating-system parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object example: ANDROID: - '97.28898' timestamps: - '2023-08-08T10:15:00Z' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/timeseries_groups/tls_version: get: tags: - Radar summary: Cloudflare Get TLS Versions Time Series description: >- Get a time series of the percentage distribution of traffic per TLS protocol version. operationId: radar-get-http-timeseries-group-by-tls-version parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - TLS 1.0 - TLS 1.1 - TLS 1.2 - TLS 1.3 - TLS QUIC properties: TLS 1.0: type: array items: type: string TLS 1.1: type: array items: type: string TLS 1.2: type: array items: type: string TLS 1.3: type: array items: type: string TLS QUIC: type: array items: type: string timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By HTTP Requests description: >- Get the top autonomous systems by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/bot_class/{bot_class}: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By Bot Class description: >- Get the top autonomous systems (AS), by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more information. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-bot-class parameters: - name: bot_class in: path required: true schema: type: string description: Bot class. enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/device_type/{device_type}: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By Device Type description: >- Get the top autonomous systems (AS), by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-device-type parameters: - name: device_type in: path required: true schema: type: string description: Device type. enum: - DESKTOP - MOBILE - OTHER - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/http_protocol/{http_protocol}: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By HTTP Protocol description: >- Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-http-protocol parameters: - name: http_protocol in: path required: true schema: type: string description: HTTP Protocol. enum: - HTTP - HTTPS - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/http_version/{http_version}: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By HTTP Version description: >- Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-http-version parameters: - name: http_version in: path required: true schema: type: string description: HTTP version. enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/ip_version/{ip_version}: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By IP Version description: >- Get the top autonomous systems, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-ip-version parameters: - name: ip_version in: path required: true schema: type: string description: IP version. enum: - IPv4 - IPv6 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/os/{os}: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By Operating System description: >- Get the top autonomous systems, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-operating-system parameters: - name: os in: path required: true schema: type: string description: IP version. enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/ases/tls_version/{tls_version}: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By TLS Version description: >- Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-ases-by-tls-version parameters: - name: tls_version in: path required: true schema: type: string description: TLS version. enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: integer example: 3243 clientASName: type: string example: MEO value: type: string example: '3' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/browser_families: get: tags: - Radar summary: Cloudflare Get Top User Agents Families by HTTP requests description: >- Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-browser-families parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: chrome value: type: string success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/browsers: get: tags: - Radar summary: Cloudflare Get Top User Agents By HTTP requests description: >- Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-browsers parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - name - value properties: name: type: string example: chrome value: type: string success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations: get: tags: - Radar summary: Cloudflare Get Top Locations By HTTP requests description: >- Get the top locations by HTTP traffic. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/bot_class/{bot_class}: get: tags: - Radar summary: Cloudflare Get Top Locations By Bot Class description: >- Get the top locations, by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-bot-class parameters: - name: bot_class in: path required: true schema: type: string description: Bot class. enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/device_type/{device_type}: get: tags: - Radar summary: Cloudflare Get Top Locations By Device Type description: >- Get the top locations, by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-device-type parameters: - name: device_type in: path required: true schema: type: string description: Device type. enum: - DESKTOP - MOBILE - OTHER - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/http_protocol/{http_protocol}: get: tags: - Radar summary: Cloudflare Get Top Locations By HTTP Protocol description: >- Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-http-protocol parameters: - name: http_protocol in: path required: true schema: type: string description: HTTP Protocol. enum: - HTTP - HTTPS - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/http_version/{http_version}: get: tags: - Radar summary: Cloudflare Get Top Locations By HTTP Version description: >- Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-http-version parameters: - name: http_version in: path required: true schema: type: string description: HTTP version. enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/ip_version/{ip_version}: get: tags: - Radar summary: Cloudflare Get Top Locations By IP Version description: >- Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-ip-version parameters: - name: ip_version in: path required: true schema: type: string description: IP version. enum: - IPv4 - IPv6 - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/os/{os}: get: tags: - Radar summary: Cloudflare Get Top Locations By Operating System description: >- Get the top locations, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-operating-system parameters: - name: os in: path required: true schema: type: string description: IP version. enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: tlsVersion in: query schema: type: array description: Filter for tls version. example: TLSv1_2 items: type: string enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/http/top/locations/tls_version/{tls_version}: get: tags: - Radar summary: Cloudflare Get Top Locations By TLS Version description: >- Get the top locations, by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic. operationId: radar-get-http-top-locations-by-tls-version parameters: - name: tls_version in: path required: true schema: type: string description: TLS version. enum: - TLSv1_0 - TLSv1_1 - TLSv1_2 - TLSv1_3 - TLSvQUIC - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: botClass in: query schema: type: array description: >- Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). example: LIKELY_AUTOMATED items: type: string enum: - LIKELY_AUTOMATED - LIKELY_HUMAN - name: deviceType in: query schema: type: array description: Filter for device type. example: DESKTOP items: type: string enum: - DESKTOP - MOBILE - OTHER - name: httpProtocol in: query schema: type: array description: Filter for http protocol. example: HTTPS items: type: string enum: - HTTP - HTTPS - name: httpVersion in: query schema: type: array description: Filter for http version. example: HTTPv1 items: type: string enum: - HTTPv1 - HTTPv2 - HTTPv3 - name: ipVersion in: query schema: type: array description: Filter for ip version. example: IPv4 items: type: string enum: - IPv4 - IPv6 - name: os in: query schema: type: array description: Filter for os name. example: WINDOWS items: type: string enum: - WINDOWS - MACOSX - IOS - ANDROID - CHROMEOS - LINUX - SMART_TV - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '65' success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/netflows/timeseries: get: tags: - Radar summary: Cloudflare Get NetFlows Time Series description: >- Get network traffic change over time. Visit https://en.wikipedia.org/wiki/NetFlow for more information on NetFlows. operationId: radar-get-netflows-timeseries parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: product in: query schema: type: array description: Array of network traffic product types. example: all items: type: string enum: - HTTP - ALL - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: normalization in: query schema: type: string description: >- Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). enum: - PERCENTAGE_CHANGE - MIN0_MAX example: MIN0_MAX - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange - aggInterval - lastUpdated properties: aggInterval: type: string example: 1h confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string format: date-time serie_0: type: object required: - timestamps - values properties: timestamps: type: array items: type: string format: date-time values: type: array items: type: string example: 0.56 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/netflows/top/ases: get: tags: - Radar summary: Cloudflare Get Top Autonomous Systems By Network Traffic description: >- Get the top autonomous systems (AS) by network traffic (NetFlows) over a given time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information. operationId: radar-get-netflows-top-ases parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - top_0 properties: top_0: type: array items: type: object required: - clientASN - clientASName - value properties: clientASN: type: number example: 16509 clientASName: type: string example: AMAZON-02 value: type: string example: '0.73996' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/netflows/top/locations: get: tags: - Radar summary: Cloudflare Get Top Locations By Network Traffic description: >- Get the top locations by network traffic (NetFlows) over a given time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information. operationId: radar-get-netflows-top-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - top_0 properties: top_0: type: array items: type: object required: - clientCountryName - clientCountryAlpha2 - value properties: clientCountryAlpha2: type: string example: US clientCountryName: type: string example: United States value: type: string example: '0.73996' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/iqi/summary: get: tags: - Radar summary: Cloudflare Get IQI Summary description: >- Get a summary (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI). operationId: radar-get-quality-index-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: metric in: query required: true schema: type: string description: 'Which metric to return: bandwidth, latency or DNS response time.' enum: - BANDWIDTH - DNS - LATENCY example: latency - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - p75 - p50 - p25 properties: p25: type: string example: '32.20938' p50: type: string example: '61.819881' p75: type: string example: '133.813087' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/iqi/timeseries_groups: get: tags: - Radar summary: Cloudflare Get IQI Time Series description: >- Get a time series (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI). operationId: radar-get-quality-index-timeseries-group parameters: - name: aggInterval in: query schema: type: string description: >- Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). enum: - 15m - 1h - 1d - 1w example: 1h - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: interpolation in: query schema: type: boolean description: Enable interpolation for all series (using the average). - name: metric in: query required: true schema: type: string description: 'Which metric to return: bandwidth, latency or DNS response time.' enum: - BANDWIDTH - DNS - LATENCY example: latency - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object serie_0: type: object required: - timestamps - p75 - p50 - p25 properties: p25: type: array items: type: string example: '31.253439' p50: type: array items: type: string example: '60.337738' p75: type: array items: type: string example: '125.940175' timestamps: type: array items: type: string example: '2023-04-17T00:00:00Z' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/histogram: get: tags: - Radar summary: Cloudflare Get Speed Tests Histogram description: >- Get an histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets. operationId: radar-get-quality-speed-histogram parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: bucketSize in: query schema: type: integer description: The width for every bucket in the histogram. - name: metricGroup in: query schema: type: string description: Metrics to be returned. enum: - BANDWIDTH - LATENCY - JITTER default: bandwidth example: bandwidth - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - histogram_0 properties: histogram_0: type: object required: - bandwidthUpload - bandwidthDownload - bucketMin properties: bandwidthDownload: type: array items: type: string example: '83681' bandwidthUpload: type: array items: type: string example: '181079' bucketMin: type: array items: type: string example: '0' meta: type: object success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/summary: get: tags: - Radar summary: Cloudflare Get Speed Tests Summary description: >- Get a summary of bandwidth, latency, jitter and packet loss, from the previous 90 days of Cloudflare Speed Test data. operationId: radar-get-quality-speed-summary parameters: - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - summary_0 properties: meta: type: object required: - dateRange - normalization - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' normalization: type: string example: PERCENTAGE summary_0: type: object required: - bandwidthDownload - bandwidthUpload - latencyIdle - latencyLoaded - jitterIdle - jitterLoaded - packetLoss properties: bandwidthDownload: type: string example: '83.765201' bandwidthUpload: type: string example: '39.005561' jitterIdle: type: string example: '25.648713' jitterLoaded: type: string example: '77.462155' latencyIdle: type: string example: '83.165385' latencyLoaded: type: string example: '270.561124' packetLoss: type: string example: '1.23705' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/top/ases: get: tags: - Radar summary: Cloudflare Get Top Speed Test Autonomous Systems description: >- Get the top autonomous systems by bandwidth, latency, jitter or packet loss, from the previous 90 days of Cloudflare Speed Test data. operationId: radar-get-quality-speed-top-ases parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: orderBy in: query schema: type: string description: Metric to order the results by. enum: - BANDWIDTH_DOWNLOAD - BANDWIDTH_UPLOAD - LATENCY_IDLE - LATENCY_LOADED - JITTER_IDLE - JITTER_LOADED default: BANDWIDTH_DOWNLOAD - name: reverse in: query schema: type: boolean description: Reverse the order of results. - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientASN - clientASName - bandwidthDownload - bandwidthUpload - latencyIdle - latencyLoaded - jitterIdle - jitterLoaded - numTests - rankPower properties: bandwidthDownload: type: string example: '642.509004' bandwidthUpload: type: string example: '300.672274' clientASN: type: number example: 33353 clientASName: type: string example: SIE-CGEI-ASN-1 jitterIdle: type: string example: '2.956908' jitterLoaded: type: string example: '19.500469' latencyIdle: type: string example: '15.925' latencyLoaded: type: string example: '65.65' numTests: type: number example: 13123 rankPower: type: number example: 0.77 success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/quality/speed/top/locations: get: tags: - Radar summary: Cloudflare Get Top Speed Test Locations description: >- Get the top locations by bandwidth, latency, jitter or packet loss, from the previous 90 days of Cloudflare Speed Test data. operationId: radar-get-quality-speed-top-locations parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: orderBy in: query schema: type: string description: Metric to order the results by. enum: - BANDWIDTH_DOWNLOAD - BANDWIDTH_UPLOAD - LATENCY_IDLE - LATENCY_LOADED - JITTER_IDLE - JITTER_LOADED default: BANDWIDTH_DOWNLOAD - name: reverse in: query schema: type: boolean description: Reverse the order of results. - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange - lastUpdated properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' lastUpdated: type: string example: '2023-07-26T08:59:57Z' top_0: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - bandwidthDownload - bandwidthUpload - latencyIdle - latencyLoaded - jitterIdle - jitterLoaded - numTests - rankPower properties: bandwidthDownload: type: string example: '295.886073' bandwidthUpload: type: string example: '158.85269' clientCountryAlpha2: type: string example: IS clientCountryName: type: string example: Iceland jitterIdle: type: string example: '9.640685' jitterLoaded: type: string example: '46.480023' latencyIdle: type: string example: '15.208124' latencyLoaded: type: string example: '114.758887' numTests: type: number example: 13123 rankPower: type: number example: 0.77 success: type: boolean example: true '404': description: Not found content: application/json: schema: type: object required: - error properties: error: type: string example: Not Found security: - api_email: [] api_key: [] api_token: [] /radar/ranking/domain/{domain}: get: tags: - Radar summary: Cloudflare Get Domains Rank details description: |- Gets Domains Rank details. Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints. operationId: radar-get-ranking-domain-details parameters: - name: domain in: path required: true schema: type: string example: google.com pattern: >- ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$ - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: rankingType in: query schema: type: string description: The ranking type. enum: - POPULAR - TRENDING_RISE - TRENDING_STEADY default: POPULAR example: POPULAR - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: date in: query schema: type: array description: Array of dates to filter the ranking. example: '2022-09-19' items: type: string nullable: true - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - details_0 properties: details_0: type: object required: - categories - top_locations properties: bucket: type: string description: >- Only available in POPULAR ranking for the most recent ranking. example: '2000' categories: type: array items: type: object required: - superCategoryId - name - id properties: id: type: number example: 81 name: type: string example: Content Servers superCategoryId: type: number example: 26 rank: type: integer example: 3 top_locations: type: array items: type: object required: - rank - locationName - locationCode properties: locationCode: type: string example: US locationName: type: string example: United States rank: type: integer example: 1 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/ranking/timeseries_groups: get: tags: - Radar summary: Cloudflare Get Domains Rank time series description: Gets Domains Rank updates change over time. Raw values are returned. operationId: radar-get-ranking-domain-timeseries parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: rankingType in: query schema: type: string description: The ranking type. enum: - POPULAR - TRENDING_RISE - TRENDING_STEADY default: POPULAR example: POPULAR - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: location in: query schema: type: array description: Array of locations (alpha-2 country codes). example: US items: type: string - name: domains in: query schema: type: array description: Array of comma separated list of domains names. example: google.com,facebook.com items: type: string pattern: >- ^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\.)+[a-zA-Z0-9-]{2,63}$ - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - serie_0 properties: meta: type: object required: - dateRange properties: dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' serie_0: type: object example: google.com: - 2 timestamps: - '2022-09-02' required: - timestamps properties: timestamps: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/ranking/top: get: tags: - Radar summary: Cloudflare Get Top or Trending Domains description: >- Get top or trending domains based on their rank. Popular domains are domains of broad appeal based on how people use the Internet. Trending domains are domains that are generating a surge in interest. For more information on top domains, see https://blog.cloudflare.com/radar-domain-rankings/. operationId: radar-get-ranking-top-domains parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: location in: query schema: type: array description: Array of locations (alpha-2 country codes). example: US items: type: string - name: date in: query schema: type: array description: Array of dates to filter the ranking. example: '2022-09-19' items: type: string nullable: true - name: rankingType in: query schema: type: string description: The ranking type. enum: - POPULAR - TRENDING_RISE - TRENDING_STEADY default: POPULAR example: POPULAR - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - top_0 properties: top_0: type: object required: - date properties: date: type: string example: '2022-09-19' top_0: type: array items: type: object required: - rank - domain - categories properties: categories: type: array items: type: object required: - superCategoryId - name - id properties: id: type: number example: 81 name: type: string example: Content Servers superCategoryId: type: number example: 26 domain: type: string example: google.com pctRankChange: type: number description: Only available in TRENDING rankings. example: 10.8 rank: type: integer example: 1 success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/search/global: get: tags: - Radar summary: Cloudflare Search for locations, autonomous systems (AS) and reports. description: Lets you search for locations, autonomous systems (AS) and reports. operationId: radar-get-search-global parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: limitPerGroup in: query schema: type: number description: Limit the number of objects per search category. - name: query in: query required: true schema: type: string description: Search for locations, AS and reports. example: United - name: include in: query schema: type: array description: Search types to be included in results. items: type: string enum: - SPECIAL_EVENTS - NOTEBOOKS - LOCATIONS - ASNS - name: exclude in: query schema: type: array description: Search types to be excluded from results. items: type: string enum: - SPECIAL_EVENTS - NOTEBOOKS - LOCATIONS - ASNS - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - search properties: search: type: array items: type: object required: - code - name - type properties: code: type: string example: '13335' name: type: string example: Cloudflare type: type: string example: asn success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/traffic_anomalies: get: tags: - Radar summary: Cloudflare Get latest Internet traffic anomalies. description: |- Internet traffic anomalies are signals that might point to an outage, These alerts are automatically detected by Radar and then manually verified by our team. This endpoint returns the latest alerts. operationId: radar-get-traffic-anomalies parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: offset in: query schema: type: integer description: Number of objects to skip before grabbing results. - name: dateRange in: query schema: type: string description: >- Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: status in: query schema: type: string enum: - VERIFIED - UNVERIFIED - name: asn in: query schema: type: integer description: Single ASN as integer. example: '174' - name: location in: query schema: type: string description: Location Alpha2 code. example: US - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: List of Internet traffic anomalies content: application/json: schema: type: object required: - result - success properties: result: type: object required: - trafficAnomalies properties: trafficAnomalies: type: array items: type: object required: - uuid - type - status - startDate properties: asnDetails: type: object required: - asn - name properties: asn: type: string example: '189' locations: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States name: type: string example: LUMEN-LEGACY-L3-PARTITION endDate: type: string example: '2023-08-03T23:15:00Z' locationDetails: type: object required: - code - name properties: code: type: string example: US name: type: string example: United States startDate: type: string example: '2023-08-02T23:15:00Z' status: type: string example: UNVERIFIED type: type: string example: LOCATION uuid: type: string example: 55a57f33-8bc0-4984-b4df-fdaff72df39d visibleInDataSources: type: array items: type: string success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/traffic_anomalies/locations: get: tags: - Radar summary: Cloudflare Get top locations by total traffic anomalies generated. description: |- Internet traffic anomalies are signals that might point to an outage, These alerts are automatically detected by Radar and then manually verified by our team. This endpoint returns the sum of alerts grouped by location. operationId: radar-get-traffic-anomalies-top parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: dateRange in: query schema: type: string description: >- Shorthand date ranges for the last X days - use when you don't need specific start and end dates. enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl example: 7d - name: dateStart in: query schema: type: string format: date-time description: Start of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: dateEnd in: query schema: type: string format: date-time description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' - name: status in: query schema: type: string enum: - VERIFIED - UNVERIFIED - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: List of locations with number of traffic anomalies content: application/json: schema: type: object required: - result - success properties: result: type: object required: - trafficAnomalies properties: trafficAnomalies: type: array items: type: object required: - clientCountryAlpha2 - clientCountryName - value properties: clientCountryAlpha2: type: string example: PT clientCountryName: type: string example: Portugal value: type: string example: '5' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/verified_bots/top/bots: get: tags: - Radar summary: Cloudflare Get Top Verified Bots By HTTP Requests description: Get top verified bots by HTTP requests, with owner and category. operationId: radar-get-verified-bots-top-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' top_0: type: array items: type: object required: - botName - botCategory - botOwner - value properties: botCategory: type: string example: Search Engine Crawler botName: type: string example: GoogleBot botOwner: type: string example: Google value: type: string example: '29.034407' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] /radar/verified_bots/top/categories: get: tags: - Radar summary: Cloudflare Get Top Verified Bot Categories By HTTP Requests description: >- Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests. operationId: radar-get-verified-bots-top-categories-by-http-requests parameters: - name: limit in: query schema: type: integer description: Limit the number of objects in the response. example: 5 - name: name in: query schema: type: array description: Array of names that will be used to name the series in responses. example: main_series items: type: string - name: dateRange in: query schema: type: array description: >- For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). items: type: string enum: - 1d - 2d - 7d - 14d - 28d - 12w - 24w - 52w - 1dControl - 2dControl - 7dControl - 14dControl - 28dControl - 12wControl - 24wControl - name: dateStart in: query schema: type: array description: Array of datetimes to filter the start of a series. example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: dateEnd in: query schema: type: array description: End of the date range (inclusive). example: '2023-09-01T11:41:33.782Z' items: type: string format: date-time - name: asn in: query schema: type: array description: >- Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356. example: '15169' items: type: string - name: location in: query schema: type: array description: >- Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT. example: US,CA items: type: string - name: continent in: query schema: type: array description: >- Array of comma separated list of continents (alpha-2 continent codes). Start with `-` to exclude from results. For example, `-EU,NA` excludes results from Europe, but includes results from North America. example: EU,NA items: type: string - name: format in: query schema: type: string description: Format results are returned in. enum: - JSON - CSV example: json responses: '200': description: Successful Response content: application/json: schema: type: object required: - result - success properties: result: type: object required: - meta - top_0 properties: meta: type: object required: - dateRange properties: confidenceInfo: type: object properties: annotations: type: array items: type: object required: - dataSource - eventType - description - isInstantaneous properties: dataSource: type: string example: ALL description: type: string example: Cable cut in Tonga endTime: type: string format: date-time eventType: type: string example: OUTAGE isInstantaneous: type: object linkedUrl: type: string startTime: type: string format: date-time level: type: integer dateRange: type: array items: type: object required: - startTime - endTime properties: endTime: type: string format: date-time description: Adjusted end of date range. example: '2022-09-17T10:22:57.555Z' startTime: type: string format: date-time description: Adjusted start of date range. example: '2022-09-16T10:22:57.555Z' top_0: type: array items: type: object required: - botCategory - value properties: botCategory: type: string example: Search value: type: string example: '65' success: type: boolean example: true '400': description: Bad Request content: application/json: schema: type: object required: - result - success - errors properties: errors: type: array items: type: object required: - message properties: message: type: string result: type: object success: type: boolean example: false security: - api_email: [] api_key: [] api_token: [] security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] servers: - url: https://api.cloudflare.com/client/v4 description: Client API tags: - name: Radar