Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DLP
Custom Prompt Topics

Create custom prompt topic

client.zeroTrust.dlp.customPromptTopics.create(CustomPromptTopicCreateParams { account_id, enabled, name, 3 more } params, RequestOptionsoptions?): CustomPromptTopic { id, created_at, enabled, 5 more }
POST/accounts/{account_id}/dlp/custom_prompt_topics

Creates a DLP custom prompt topic entry.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Zero Trust Write
ParametersExpand Collapse
params: CustomPromptTopicCreateParams { account_id, enabled, name, 3 more }
account_id: string

Path param

enabled: boolean

Body param

name: string

Body param

topic: string

Body param

maxLength50
description?: string | null

Body param

profile_id?: string

Body param

formatuuid
ReturnsExpand Collapse
CustomPromptTopic { id, created_at, enabled, 5 more }
id: string
formatuuid
created_at: string
formatdate-time
Deprecatedenabled: boolean
name: string
topic: string
maxLength50
updated_at: string
formatdate-time
description?: string | null
Deprecatedprofile_id?: string | null
formatuuid

Create custom prompt topic

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const customPromptTopic = await client.zeroTrust.dlp.customPromptTopics.create({
  account_id: 'account_id',
  enabled: true,
  name: 'name',
  topic: 'topic',
});

console.log(customPromptTopic.id);
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "enabled": true,
    "name": "name",
    "topic": "topic",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "enabled": true,
    "name": "name",
    "topic": "topic",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}