Create allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.create(, ?): AllowlistCreateResponse { id, comment, created_on, 3 more }

POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist

Create an allowlist 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: AllowlistCreateParams { account_id, comment, enabled, prefix }

account_id: string

Path param: Identifier.

maxLength32

comment: string

Body param: An comment describing the allowlist prefix.

enabled: boolean

Body param: Whether to enable the allowlist prefix into effect.

prefix: string

Body param: The allowlist prefix to add in CIDR format.

ReturnsExpand Collapse

AllowlistCreateResponse { id, comment, created_on, 3 more }

id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: boolean

Whether to enable the allowlist prefix into effect. Defaults to false.

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: string

The allowlist prefix in CIDR format.

Create allowlist prefix.

import Cloudflare from 'cloudflare';

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

const allowlist = await client.DDoSProtection.advancedTCPProtection.allowlist.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  comment: 'comment',
  enabled: true,
  prefix: 'prefix',
});

console.log(allowlist.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",
    "enabled": true,
    "modified_on": "2019-12-27T18:11:19.117Z",
    "prefix": "prefix"
  }
}

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",
    "enabled": true,
    "modified_on": "2019-12-27T18:11:19.117Z",
    "prefix": "prefix"
  }
}