List sinkholes owned by this account

client.intel.sinkholes.list(, ?): SinglePage<Sinkhole { id, account_tag, created_on, 4 more } >

GET/accounts/{account_id}/intel/sinkholes

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 WriteIntel Read

ParametersExpand Collapse

params: SinkholeListParams { account_id }

account_id: string

Identifier

maxLength32

ReturnsExpand Collapse

Sinkhole { id, account_tag, created_on, 4 more }

id?: number

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

List sinkholes owned by this 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
});

// Automatically fetches more pages as needed.
for await (const sinkhole of client.intel.sinkholes.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  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": 1,
      "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
      "created_on": "2023-05-12T12:21:56.777653Z",
      "modified_on": "2023-06-18T03:13:34.123321Z",
      "name": "sinkhole_1",
      "r2_bucket": "my_bucket",
      "r2_id": "<r2_id>"
    },
    {
      "id": 2,
      "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
      "created_on": "2023-05-21T21:43:52.867525Z",
      "modified_on": "2023-06-28T18:46:18.764425Z",
      "name": "sinkhole_1",
      "r2_bucket": "my_bucket",
      "r2_id": "<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": 1,
      "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
      "created_on": "2023-05-12T12:21:56.777653Z",
      "modified_on": "2023-06-18T03:13:34.123321Z",
      "name": "sinkhole_1",
      "r2_bucket": "my_bucket",
      "r2_id": "<r2_id>"
    },
    {
      "id": 2,
      "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
      "created_on": "2023-05-21T21:43:52.867525Z",
      "modified_on": "2023-06-28T18:46:18.764425Z",
      "name": "sinkhole_1",
      "r2_bucket": "my_bucket",
      "r2_id": "<r2_id>"
    }
  ]
}