Skip to content
Cloudflare API
Start here
API Reference
Intel

Sinkholes

List sinkholes owned by this account
client.intel.sinkholes.list(SinkholeListParams { account_id } params, RequestOptionsoptions?): SinglePage<Sinkhole { id, account_tag, created_on, 4 more } >
GET/accounts/{account_id}/intel/sinkholes
Get a sinkhole
client.intel.sinkholes.get(stringsinkholeID, SinkholeGetParams { account_id } params, RequestOptionsoptions?): Sinkhole { id, account_tag, created_on, 4 more }
GET/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Create a new sinkhole for your account
client.intel.sinkholes.create(SinkholeCreateParams { account_id, name, r2_bucket, 2 more } params, RequestOptionsoptions?): Sinkhole { id, account_tag, created_on, 4 more }
POST/accounts/{account_id}/intel/sinkholes
Update a sinkhole
client.intel.sinkholes.update(stringsinkholeID, SinkholeUpdateParams { account_id, name, r2_bucket, 2 more } params, RequestOptionsoptions?): SinkholeUpdateResponse
PUT/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Delete a sinkhole
client.intel.sinkholes.delete(stringsinkholeID, SinkholeDeleteParams { account_id } params, RequestOptionsoptions?): SinkholeDeleteResponse
DELETE/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
ModelsExpand 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.

SinkholeUpdateResponse = unknown
SinkholeDeleteResponse = unknown

SinkholesIngresses

Create an ingress rule
client.intel.sinkholes.ingresses.create(stringsinkholeID, IngressCreateParams { zone_id, cidr } params, RequestOptionsoptions?): IngressCreateResponse { id, cidr, created_on, 3 more }
POST/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses
Get an ingress rule
client.intel.sinkholes.ingresses.get(stringingressID, IngressGetParams { zone_id, sinkhole_id } params, RequestOptionsoptions?): IngressGetResponse { id, cidr, created_on, 3 more }
GET/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Update an ingress rule
client.intel.sinkholes.ingresses.update(stringingressID, IngressUpdateParams { zone_id, sinkhole_id, cidr } params, RequestOptionsoptions?): IngressUpdateResponse
PUT/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Delete an ingress rule
client.intel.sinkholes.ingresses.delete(stringingressID, IngressDeleteParams { zone_id, sinkhole_id } params, RequestOptionsoptions?): IngressDeleteResponse
DELETE/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
ModelsExpand Collapse
IngressCreateResponse { id, cidr, created_on, 3 more }
id?: string

The unique identifier for the ingress rule.

cidr?: string

The CIDR block for the ingress rule.

created_on?: string

The date and time when the ingress rule was created.

formatdate-time
modified_on?: string

The date and time when the ingress rule was last modified.

formatdate-time
sinkhole_id?: string

The sinkhole this ingress rule belongs to.

zone_tag?: string

The zone tag associated with this ingress rule.

IngressGetResponse { id, cidr, created_on, 3 more }
id?: string

The unique identifier for the ingress rule.

cidr?: string

The CIDR block for the ingress rule.

created_on?: string

The date and time when the ingress rule was created.

formatdate-time
modified_on?: string

The date and time when the ingress rule was last modified.

formatdate-time
sinkhole_id?: string

The sinkhole this ingress rule belongs to.

zone_tag?: string

The zone tag associated with this ingress rule.

IngressUpdateResponse = unknown
IngressDeleteResponse = unknown