Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.
Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.
To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to
our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).
Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
license:
name: BSD-3-Clause
url: https://opensource.org/licenses/BSD-3-Clause
title: APIs.io Engineering Platform Cloudflare Radar Http API
version: 4.0.0
tags:
- name: Radar Http
paths:
/radar/http/summary/bot_class:
get:
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:
- description: Array of names that will be used to name the series in responses.
in: query
name: name
schema:
description: Array of names that will be used to name the series in responses.
example: main_series
items:
type: string
type: array
- description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
in: query
name: dateRange
schema:
description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
example: 7d
items:
example: 7d
pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
type: string
type: array
- description: Array of datetimes to filter the start of a series.
in: query
name: dateStart
schema:
description: Array of datetimes to filter the start of a series.
example: '2023-09-01T11:41:33.782Z'
items:
format: date-time
type: string
type: array
- description: End of the date range (inclusive).
in: query
name: dateEnd
schema:
description: End of the date range (inclusive).
example: '2023-09-01T11:41:33.782Z'
items:
format: date-time
type: string
type: array
- description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
in: query
name: asn
schema:
description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
example: '15169'
items:
type: string
type: array
- description: Array of 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.
in: query
name: location
schema:
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
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.
in: query
name: continent
schema:
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
type: array
- description: Filter for device type.
in: query
name: deviceType
schema:
description: Filter for device type.
example: DESKTOP
items:
enum:
- DESKTOP
- MOBILE
- OTHER
type: string
type: array
- description: Filter for http protocol.
in: query
name: httpProtocol
schema:
description: Filter for http protocol.
example: HTTPS
items:
enum:
- HTTP
- HTTPS
type: string
type: array
- description: Filter for http version.
in: query
name: httpVersion
schema:
description: Filter for http version.
example: HTTPv1
items:
enum:
- HTTPv1
- HTTPv2
- HTTPv3
type: string
type: array
- description: Filter for ip version.
in: query
name: ipVersion
schema:
description: Filter for ip version.
example: IPv4
items:
enum:
- IPv4
- IPv6
type: string
type: array
- description: Filter for os name.
in: query
name: os
schema:
description: Filter for os name.
example: WINDOWS
items:
enum:
- WINDOWS
- MACOSX
- IOS
- ANDROID
- CHROMEOS
- LINUX
- SMART_TV
type: string
type: array
- description: Filter for tls version.
in: query
name: tlsVersion
schema:
description: Filter for tls version.
example: TLSv1_2
items:
enum:
- TLSv1_0
- TLSv1_1
- TLSv1_2
- TLSv1_3
- TLSvQUIC
type: string
type: array
- description: Format results are returned in.
in: query
name: format
schema:
description: Format results are returned in.
enum:
- JSON
- CSV
example: json
type: string
responses:
'200':
content:
application/json:
schema:
properties:
result:
properties:
meta:
properties:
confidenceInfo:
properties:
annotations:
items:
properties:
dataSource:
example: ALL
type: string
description:
example: Cable cut in Tonga
type: string
endTime:
format: date-time
type: string
eventType:
example: OUTAGE
type: string
isInstantaneous:
example: true
type: boolean
linkedUrl:
type: string
startTime:
format: date-time
type: string
required:
- dataSource
- eventType
- description
- isInstantaneous
type: object
type: array
level:
type: integer
type: object
dateRange:
items:
properties:
endTime:
description: Adjusted end of date range.
example: '2022-09-17T10:22:57.555Z'
format: date-time
type: string
startTime:
description: Adjusted start of date range.
example: '2022-09-16T10:22:57.555Z'
format: date-time
type: string
required:
- startTime
- endTime
type: object
type: array
lastUpdated:
example: '2023-07-26T08:59:57Z'
type: string
normalization:
example: PERCENTAGE
type: string
required:
- dateRange
- normalization
- lastUpdated
type: object
summary_0:
properties:
bot:
example: '35'
type: string
human:
example: '65'
type: string
required:
- human
- bot
type: object
required:
- meta
- summary_0
type: object
success:
example: true
type: boolean
required:
- result
- success
type: object
description: Successful Response
'400':
content:
application/json:
schema:
properties:
errors:
items:
properties:
message:
type: string
required:
- message
type: object
type: array
result:
type: object
success:
example: false
type: boolean
required:
- result
- success
- errors
type: object
description: Bad Request
security:
- api_email: []
api_key: []
api_token: []
summary: APIs.io Engineering Platform Get Bot Class Summary
tags:
- Radar Http
x-cfPermissionsRequired:
enum:
- com.cloudflare.api.user.read
x-cfPlanAvailability:
business: true
enterprise: true
free: true
pro: true
/radar/http/summary/device_type:
get:
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:
- description: Array of names that will be used to name the series in responses.
in: query
name: name
schema:
description: Array of names that will be used to name the series in responses.
example: main_series
items:
type: string
type: array
- description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
in: query
name: dateRange
schema:
description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
example: 7d
items:
example: 7d
pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
type: string
type: array
- description: Array of datetimes to filter the start of a series.
in: query
name: dateStart
schema:
description: Array of datetimes to filter the start of a series.
example: '2023-09-01T11:41:33.782Z'
items:
format: date-time
type: string
type: array
- description: End of the date range (inclusive).
in: query
name: dateEnd
schema:
description: End of the date range (inclusive).
example: '2023-09-01T11:41:33.782Z'
items:
format: date-time
type: string
type: array
- description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
in: query
name: asn
schema:
description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
example: '15169'
items:
type: string
type: array
- description: Array of 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.
in: query
name: location
schema:
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
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.
in: query
name: continent
schema:
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
type: array
- description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
in: query
name: botClass
schema:
description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
example: LIKELY_AUTOMATED
items:
enum:
- LIKELY_AUTOMATED
- LIKELY_HUMAN
type: string
type: array
- description: Filter for http protocol.
in: query
name: httpProtocol
schema:
description: Filter for http protocol.
example: HTTPS
items:
enum:
- HTTP
- HTTPS
type: string
type: array
- description: Filter for http version.
in: query
name: httpVersion
schema:
description: Filter for http version.
example: HTTPv1
items:
enum:
- HTTPv1
- HTTPv2
- HTTPv3
type: string
type: array
- description: Filter for ip version.
in: query
name: ipVersion
schema:
description: Filter for ip version.
example: IPv4
items:
enum:
- IPv4
- IPv6
type: string
type: array
- description: Filter for os name.
in: query
name: os
schema:
description: Filter for os name.
example: WINDOWS
items:
enum:
- WINDOWS
- MACOSX
- IOS
- ANDROID
- CHROMEOS
- LINUX
- SMART_TV
type: string
type: array
- description: Filter for tls version.
in: query
name: tlsVersion
schema:
description: Filter for tls version.
example: TLSv1_2
items:
enum:
- TLSv1_0
- TLSv1_1
- TLSv1_2
- TLSv1_3
- TLSvQUIC
type: string
type: array
- description: Format results are returned in.
in: query
name: format
schema:
description: Format results are returned in.
enum:
- JSON
- CSV
example: json
type: string
responses:
'200':
content:
application/json:
schema:
properties:
result:
properties:
meta:
properties:
confidenceInfo:
properties:
annotations:
items:
properties:
dataSource:
example: ALL
type: string
description:
example: Cable cut in Tonga
type: string
endTime:
format: date-time
type: string
eventType:
example: OUTAGE
type: string
isInstantaneous:
example: true
type: boolean
linkedUrl:
type: string
startTime:
format: date-time
type: string
required:
- dataSource
- eventType
- description
- isInstantaneous
type: object
type: array
level:
type: integer
type: object
dateRange:
items:
properties:
endTime:
description: Adjusted end of date range.
example: '2022-09-17T10:22:57.555Z'
format: date-time
type: string
startTime:
description: Adjusted start of date range.
example: '2022-09-16T10:22:57.555Z'
format: date-time
type: string
required:
- startTime
- endTime
type: object
type: array
lastUpdated:
example: '2023-07-26T08:59:57Z'
type: string
normalization:
example: PERCENTAGE
type: string
required:
- dateRange
- normalization
- lastUpdated
type: object
summary_0:
properties:
desktop:
example: '65'
type: string
mobile:
example: '30'
type: string
other:
example: '5'
type: string
required:
- desktop
- mobile
- other
type: object
required:
- meta
- summary_0
type: object
success:
example: true
type: boolean
required:
- result
- success
type: object
description: Successful Response
'400':
content:
application/json:
schema:
properties:
errors:
items:
properties:
message:
type: string
required:
- message
type: object
type: array
result:
type: object
success:
example: false
type: boolean
required:
- result
- success
- errors
type: object
description: Bad Request
security:
- api_email: []
api_key: []
api_token: []
summary: APIs.io Engineering Platform Get Device Type Summary
tags:
- Radar Http
x-cfPermissionsRequired:
enum:
- com.cloudflare.api.user.read
x-cfPlanAvailability:
business: true
enterprise: true
free: true
pro: true
/radar/http/summary/http_protocol:
get:
description: Percentage distribution of traffic per HTTP protocol over a given time period.
operationId: radar-get-http-summary-by-http-protocol
parameters:
- description: Array of names that will be used to name the series in responses.
in: query
name: name
schema:
description: Array of names that will be used to name the series in responses.
example: main_series
items:
type: string
type: array
- description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
in: query
name: dateRange
schema:
description: For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).
example: 7d
items:
example: 7d
pattern: ^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$
type: string
type: array
- description: Array of datetimes to filter the start of a series.
in: query
name: dateStart
schema:
description: Array of datetimes to filter the start of a series.
example: '2023-09-01T11:41:33.782Z'
items:
format: date-time
type: string
type: array
- description: End of the date range (inclusive).
in: query
name: dateEnd
schema:
description: End of the date range (inclusive).
example: '2023-09-01T11:41:33.782Z'
items:
format: date-time
type: string
type: array
- description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
in: query
name: asn
schema:
description: Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.
example: '15169'
items:
type: string
type: array
- description: Array of 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.
in: query
name: location
schema:
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
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.
in: query
name: continent
schema:
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
type: array
- description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
in: query
name: botClass
schema:
description: Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
example: LIKELY_AUTOMATED
items:
enum:
- LIKELY_AUTOMATED
- LIKELY_HUMAN
type: string
type: array
- description: Filter for device type.
in: query
name: deviceType
schema:
description: Filter for device type.
example: DESKTOP
items:
enum:
- DESKTOP
- MOBILE
- OTHER
type: string
type: array
- description: Filter for http version.
in: query
name: httpVersion
schema:
description: Filter for http version.
example: HTTPv1
items:
enum:
- HTTPv1
- HTTPv2
- HTTPv3
type: string
type: array
- description: Filter for ip version.
in: query
name: ipVersion
schema:
description: Filter for ip version.
example: IPv4
items:
enum:
- IPv4
- IPv6
type: string
type: array
- description: Filter for os name.
in: query
name: os
schema:
description: Filter for os name.
example: WINDOWS
items:
enum:
- WINDOWS
- MACOSX
- IOS
- ANDROID
- CHROMEOS
- LINUX
- SMART_TV
type: string
type: array
- description: Filter for tls version.
in: query
name: tlsVersion
schema:
description: Filter for tls version.
example: TLSv1_2
items:
enum:
- TLSv1_0
- TLSv1_1
- TLSv1_2
- TLSv1_3
- TLSvQUIC
type: string
type: array
- description: Format results are returned in.
in: query
name: format
schema:
description: Format results are returned in.
enum:
- JSON
- CSV
example: json
type: string
responses:
'200':
content:
application/json:
schema:
properties:
result:
properties:
meta:
properties:
confidenceInfo:
properties:
annotations:
items:
properties:
dataSource:
example: ALL
type: string
description:
example: Cable cut in Tonga
type: string
endTime:
format: date-time
type: string
eventType:
example: OUTAGE
type: string
isInstantaneous:
example: true
type: boolean
linkedUrl:
type: string
startTime:
format: date-time
type: string
required:
- dataSource
- eventType
- description
- isInstantaneous
type: object
type: array
level:
type: integer
type: object
dateRange:
items:
properties:
endTime:
description: Adjusted end of date range.
example: '2022-09-17T10:22:57.555Z'
format: date-time
type: string
startTime:
description: Adjusted start of date range.
example: '2022-09-16T10:22:57.555Z'
format: date-time
type: string
required:
- startTime
- endTime
type: object
type: array
lastUpdated:
# --- truncated at 32 KB (422 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-radar-http-api-openapi.yml