Skip to content
Cloudflare API
Start here
API Reference
DDoS Protection
Advanced TCP Protection
Prefixes

Create prefix.

client.DDoSProtection.advancedTCPProtection.prefixes.create(PrefixCreateParams { account_id, comment, excluded, prefix } params, RequestOptionsoptions?): PrefixCreateResponse { id, comment, created_on, 3 more }
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes

Create a prefix for an account.

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)
DDoS Protection Write
ParametersExpand Collapse
params: PrefixCreateParams { account_id, comment, excluded, prefix }
account_id: string

Path param: Identifier.

maxLength32
comment: string

Body param: A comment describing the prefix.

excluded: boolean

Body param: Whether to exclude the prefix from protection.

prefix: string

Body param: The prefix to add in CIDR format.

ReturnsExpand Collapse
PrefixCreateResponse { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

Create prefix.

import Cloudflare from 'cloudflare';

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

const prefix = await client.DDoSProtection.advancedTCPProtection.prefixes.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  comment: 'comment',
  excluded: true,
  prefix: '192.0.2.0/24',
});

console.log(prefix.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": "id",
    "comment": "comment",
    "created_on": "2019-12-27T18:11:19.117Z",
    "excluded": true,
    "modified_on": "2019-12-27T18:11:19.117Z",
    "prefix": "192.0.2.0/24"
  }
}
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": "id",
    "comment": "comment",
    "created_on": "2019-12-27T18:11:19.117Z",
    "excluded": true,
    "modified_on": "2019-12-27T18:11:19.117Z",
    "prefix": "192.0.2.0/24"
  }
}