Skip to content
Start here

AI Security

Get AI Security for Apps Status
client.aiSecurity.get(AISecurityGetParams { zone_id } params, RequestOptionsoptions?): AISecurityGetResponse { enabled }
GET/zones/{zone_id}/ai-security/settings
Set AI Security for Apps Status
client.aiSecurity.update(AISecurityUpdateParams { zone_id, enabled } params, RequestOptionsoptions?): AISecurityUpdateResponse { enabled }
PUT/zones/{zone_id}/ai-security/settings
ModelsExpand Collapse
AISecurityGetResponse { enabled }

AI Security for Apps enablement status for a zone.

enabled?: boolean

Whether AI Security for Apps is enabled on the zone.

AISecurityUpdateResponse { enabled }

AI Security for Apps enablement status for a zone.

enabled?: boolean

Whether AI Security for Apps is enabled on the zone.

AI SecurityCustom Topics

Get AI Security for Apps Custom Topics
client.aiSecurity.customTopics.get(CustomTopicGetParams { zone_id } params, RequestOptionsoptions?): CustomTopicGetResponse { topics }
GET/zones/{zone_id}/ai-security/custom-topics
Set AI Security for Apps Custom Topics
client.aiSecurity.customTopics.update(CustomTopicUpdateParams { zone_id, topics } params, RequestOptionsoptions?): CustomTopicUpdateResponse { topics }
PUT/zones/{zone_id}/ai-security/custom-topics
ModelsExpand Collapse
CustomTopicGetResponse { topics }
topics?: Array<Topic>

Custom topic categories for AI Security for Apps content detection.

label: string

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

maxLength20
minLength2
topic: string

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

maxLength50
minLength2
CustomTopicUpdateResponse { topics }
topics?: Array<Topic>

Custom topic categories for AI Security for Apps content detection.

label: string

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

maxLength20
minLength2
topic: string

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

maxLength50
minLength2