bots

Creates, updates, deletes, gets or lists a bots resource.

Overview

Name	bots
Type	Resource
Id	cloudflare.radar.bots

Fields

The following fields are returned by SELECT queries:

get

Successful response.

Name	Datatype	Description
bot	object

list

Successful response.

Name	Datatype	Description
name	string	The name of the bot.
category	string	The category of the bot.
description	string	A summary for the bot (e.g., purpose).
kind	string	The kind of the bot.
operator	string	The organization that owns and operates the bot.
slug	string	A kebab-case identifier derived from the bot name.
userAgentPatterns	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bot_slug	format	Retrieves the requested bot information.
list	select		limit, offset, botCategory, botOperator, kind, botVerificationStatus, format	Retrieves a list of bots.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bot_slug	string	Bot slug.
botCategory	string	Filters results by bot category.
botOperator	string	Filters results by bot operator.
botVerificationStatus	string	Filters results by bot verification status.
format	string	Format in which results will be returned.
kind	string	Filters results by bot kind.
limit	integer	Limits the number of objects returned in the response.
offset	integer	Skips the specified number of objects before fetching the results.

SELECT examples

get

Retrieves the requested bot information.

SELECT
bot
FROM cloudflare.radar.bots
WHERE bot_slug = '{{ bot_slug }}' -- required
AND format = '{{ format }}'
;

list

Retrieves a list of bots.

SELECT
name,
category,
description,
kind,
operator,
slug,
userAgentPatterns
FROM cloudflare.radar.bots
WHERE limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND botCategory = '{{ botCategory }}'
AND botOperator = '{{ botOperator }}'
AND kind = '{{ kind }}'
AND botVerificationStatus = '{{ botVerificationStatus }}'
AND format = '{{ format }}'
;