Create predefined entry

client.zeroTrust.dlp.entries.predefined.create(, ?): PredefinedCreateResponse { id, confidence, enabled, 3 more }

POST/accounts/{account_id}/dlp/entries/predefined

Predefined entries can’t be created, this will update an existing predefined entry. This is needed for our generated terraform API.

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: PredefinedCreateParams { account_id, enabled, entry_id, profile_id }

account_id: string

Path param

enabled: boolean

Body param

entry_id: string

Body param

formatuuid

profile_id?: string | null

Body param: This field is not used as the owning profile. For predefined entries it is already set to a predefined profile.

formatuuid

ReturnsExpand Collapse

PredefinedCreateResponse { id, confidence, enabled, 3 more }

id: string

formatuuid

confidence: Confidence { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

A customer-facing explanation of what this predefined AI prompt topic represents.

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

A customer-facing explanation of what this predefined entry represents.

Create predefined entry

import Cloudflare from 'cloudflare';

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

const predefined = await client.zeroTrust.dlp.entries.predefined.create({
  account_id: 'account_id',
  enabled: true,
  entry_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(predefined.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",
    "confidence": {
      "ai_context_available": true,
      "available": true
    },
    "enabled": true,
    "name": "name",
    "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "variant": {
      "topic_type": "Intent",
      "type": "PromptTopic",
      "description": "description"
    }
  }
}

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",
    "confidence": {
      "ai_context_available": true,
      "available": true
    },
    "enabled": true,
    "name": "name",
    "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "variant": {
      "topic_type": "Intent",
      "type": "PromptTopic",
      "description": "description"
    }
  }
}