Create a DLS prefix binding

client.dls.regionalServices.prefixBindings.create(, ?): PrefixBindingCreateResponse { id, cidr, prefix_id, region_key }

POST/accounts/{account_id}/dls/regional_services/prefix_bindings

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

ParametersExpand Collapse

params: PrefixBindingCreateParams { account_id, cidr, prefix_id, region_key }

account_id: string

Path param: Identifier of a Cloudflare account.

maxLength32

minLength32

cidr: string

Body param: IP prefix in CIDR notation to bind.

prefix_id: string

Body param: The ID of the parent IP prefix that contains the CIDR.

maxLength64

region_key: string

Body param: Region key from managed regions (e.g., “us”, “eu”).

maxLength128

minLength1

ReturnsExpand Collapse

PrefixBindingCreateResponse { id, cidr, prefix_id, region_key }

id: string

The ID of the binding.

cidr: string

The CIDR that is bound.

prefix_id: string

The ID of the parent prefix.

region_key: string

The region key used for the binding.

maxLength128

minLength1

Create a DLS prefix binding

import Cloudflare from 'cloudflare';

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

const prefixBinding = await client.dls.regionalServices.prefixBindings.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  cidr: '10.0.1.0/24',
  prefix_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  region_key: 'eu',
});

console.log(prefixBinding.id);

{
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "cidr": "cidr",
    "prefix_id": "prefix_id",
    "region_key": "x"
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ]
}

Returns Examples

{
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "cidr": "cidr",
    "prefix_id": "prefix_id",
    "region_key": "x"
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ]
}