Skip to content
Cloudflare API
Start here
API Reference

AI Security

Get the AI Security for Apps status for a zone.
ai_security.get(AISecurityGetParams**kwargs) -> AISecurityGetResponse
GET/zones/{zone_id}/ai-security/settings
Update the AI Security for Apps status for a zone.
ai_security.update(AISecurityUpdateParams**kwargs) -> AISecurityUpdateResponse
PUT/zones/{zone_id}/ai-security/settings
ModelsExpand Collapse
class AISecurityGetResponse: …

AI Security for Apps enablement status for a zone.

enabled: Optional[bool]

Whether AI Security for Apps is enabled on the zone.

class AISecurityUpdateResponse: …

AI Security for Apps enablement status for a zone.

enabled: Optional[bool]

Whether AI Security for Apps is enabled on the zone.

AI SecurityCustom Topics

Get the AI Security for Apps custom topics of a zone.
ai_security.custom_topics.get(CustomTopicGetParams**kwargs) -> CustomTopicGetResponse
GET/zones/{zone_id}/ai-security/custom-topics
Update the AI Security for Apps custom topics of a zone.
ai_security.custom_topics.update(CustomTopicUpdateParams**kwargs) -> CustomTopicUpdateResponse
PUT/zones/{zone_id}/ai-security/custom-topics
ModelsExpand Collapse
class CustomTopicGetResponse: …
topics: Optional[List[Topic]]

Custom topic categories for AI Security for Apps content detection.

label: str

Unique label identifier. Must contain only lowercase letters (a–z), digits (0–9), and hyphens.

maxLength20
minLength2
topic: str

Description of the topic category. Must contain only printable ASCII characters.

maxLength50
minLength2
class CustomTopicUpdateResponse: …
topics: Optional[List[Topic]]

Custom topic categories for AI Security for Apps content detection.

label: str

Unique label identifier. Must contain only lowercase letters (a–z), digits (0–9), and hyphens.

maxLength20
minLength2
topic: str

Description of the topic category. Must contain only printable ASCII characters.

maxLength50
minLength2