Create a new sinkhole for your account

client.intel.sinkholes.create(, ?): Sinkhole { id, account_tag, created_on, 4 more }

POST/accounts/{account_id}/intel/sinkholes

Create a new sinkhole. Logs of large request bodies will be truncated, but the full request body can be recorded in R2. If you wish to record large request bodies in R2, include the R2 key ID, key secret, and bucket name in the request body.

Security

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)

Intel Write

ParametersExpand Collapse

params: SinkholeCreateParams { account_id, name, r2_bucket, 2 more }

account_id: string

Path param: Identifier.

maxLength32

name: string

Body param: The name of the sinkhole.

r2_bucket?: string

Body param: The name of the R2 bucket to store results. Required if you want to store large request bodies in R2.

r2_id?: string

Body param: The id of the R2 instance. Required if you want to store large request bodies in R2.

r2_secret?: string

Body param: The secret key for the R2 API token. Required if you want to store large request bodies in R2.

ReturnsExpand Collapse

Sinkhole { id, account_tag, created_on, 4 more }

id?: string

The unique identifier for the sinkhole.

account_tag?: string

The account tag that owns this sinkhole.

created_on?: string

The date and time when the sinkhole was created.

formatdate-time

modified_on?: string

The date and time when the sinkhole was last modified.

formatdate-time

name?: string

The name of the sinkhole.

r2_bucket?: string

The name of the R2 bucket to store results.

r2_id?: string

The id of the R2 instance.

Create a new sinkhole for your account

import Cloudflare from 'cloudflare';

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

const sinkhole = await client.intel.sinkholes.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  name: 'name',
});

console.log(sinkhole.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": "93defa6e909e464e8c89a85859f36d3c",
    "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
    "created_on": "2023-05-12T12:21:56.777653Z",
    "modified_on": "2023-06-18T03:13:34.123321Z",
    "name": "my_sinkhole",
    "r2_bucket": "my_bucket",
    "r2_id": "example_r2_id"
  }
}

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": "93defa6e909e464e8c89a85859f36d3c",
    "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
    "created_on": "2023-05-12T12:21:56.777653Z",
    "modified_on": "2023-06-18T03:13:34.123321Z",
    "name": "my_sinkhole",
    "r2_bucket": "my_bucket",
    "r2_id": "example_r2_id"
  }
}