# AI Security

## Get AI Security for Apps Status

**get** `/zones/{zone_id}/ai-security/settings`

Get whether AI Security for Apps is enabled or disabled for a zone.

### Path Parameters

- `zone_id: string`

  Defines the zone.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

- `result: object { enabled }`

  AI Security for Apps enablement status for a zone.

  - `enabled: optional boolean`

    Whether AI Security for Apps is enabled on the zone.

- `success: true`

  Defines whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/ai-security/settings \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "enabled": true
  },
  "success": true
}
```

## Set AI Security for Apps Status

**put** `/zones/{zone_id}/ai-security/settings`

Enable or disable AI Security for Apps for a zone.

Changes can take up to a minute to propagate to the zone.

### Path Parameters

- `zone_id: string`

  Defines the zone.

### Body Parameters

- `enabled: optional boolean`

  Whether AI Security for Apps is enabled on the zone.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

- `result: object { enabled }`

  AI Security for Apps enablement status for a zone.

  - `enabled: optional boolean`

    Whether AI Security for Apps is enabled on the zone.

- `success: true`

  Defines whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/ai-security/settings \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "enabled": true
        }'
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "enabled": true
  },
  "success": true
}
```

## Domain Types

### AI Security Get Response

- `AISecurityGetResponse object { enabled }`

  AI Security for Apps enablement status for a zone.

  - `enabled: optional boolean`

    Whether AI Security for Apps is enabled on the zone.

### AI Security Update Response

- `AISecurityUpdateResponse object { enabled }`

  AI Security for Apps enablement status for a zone.

  - `enabled: optional boolean`

    Whether AI Security for Apps is enabled on the zone.

# Custom Topics

## Get AI Security for Apps Custom Topics

**get** `/zones/{zone_id}/ai-security/custom-topics`

Get the AI Security for Apps custom topic categories for a zone.

### Path Parameters

- `zone_id: string`

  Defines the zone.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

- `result: object { topics }`

  - `topics: optional array of object { label, 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.

    - `topic: string`

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

- `success: true`

  Defines whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/ai-security/custom-topics \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "topics": [
      {
        "label": "credit-cards",
        "topic": "credit card numbers"
      }
    ]
  },
  "success": true
}
```

## Set AI Security for Apps Custom Topics

**put** `/zones/{zone_id}/ai-security/custom-topics`

Set the AI Security for Apps custom topic categories for a zone.

A maximum of 20 custom topics can be configured per zone.
Each topic label must be 2–20 characters using only lowercase letters (a–z), digits (0–9), and hyphens.
Each topic description must be 2–50 printable ASCII characters.

Changes can take up to a minute to propagate to the zone.

### Path Parameters

- `zone_id: string`

  Defines the zone.

### Body Parameters

- `topics: optional array of object { label, 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.

  - `topic: string`

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

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

- `result: object { topics }`

  - `topics: optional array of object { label, 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.

    - `topic: string`

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

- `success: true`

  Defines whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/ai-security/custom-topics \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{}'
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "topics": [
      {
        "label": "credit-cards",
        "topic": "credit card numbers"
      }
    ]
  },
  "success": true
}
```

## Domain Types

### Custom Topic Get Response

- `CustomTopicGetResponse object { topics }`

  - `topics: optional array of object { label, 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.

    - `topic: string`

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

### Custom Topic Update Response

- `CustomTopicUpdateResponse object { topics }`

  - `topics: optional array of object { label, 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.

    - `topic: string`

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