---
title: Sinkholes
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Intel](https://developers.cloudflare.com/api/typescript/resources/intel)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Sinkholes

##### [List sinkholes owned by this account](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/list)

client.intel.sinkholes.list(SinkholeListParams { account\_id } params, RequestOptionsoptions?): SinglePage<[Sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes%20%3E%20%28model%29%20sinkhole%20%3E%20%28schema%29) { id, account\_tag, created\_on, 4 more } \>

GET/accounts/{account\_id}/intel/sinkholes

##### [Get a sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/get)

client.intel.sinkholes.get(stringsinkholeID, SinkholeGetParams { account\_id } params, RequestOptionsoptions?): [Sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes%20%3E%20%28model%29%20sinkhole%20%3E%20%28schema%29) { id, account\_tag, created\_on, 4 more } 

GET/accounts/{account\_id}/intel/sinkholes/{sinkhole\_id}

##### [Create a new sinkhole for your account](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/create)

client.intel.sinkholes.create(SinkholeCreateParams { account\_id, name, r2\_bucket, 2 more } params, RequestOptionsoptions?): [Sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes%20%3E%20%28model%29%20sinkhole%20%3E%20%28schema%29) { id, account\_tag, created\_on, 4 more } 

POST/accounts/{account\_id}/intel/sinkholes

##### [Update a sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/update)

client.intel.sinkholes.update(stringsinkholeID, SinkholeUpdateParams { account\_id, name, r2\_bucket, 2 more } params, RequestOptionsoptions?): [SinkholeUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes%20%3E%20%28model%29%20sinkhole%5Fupdate%5Fresponse%20%3E%20%28schema%29)

PUT/accounts/{account\_id}/intel/sinkholes/{sinkhole\_id}

##### [Delete a sinkhole](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/methods/delete)

client.intel.sinkholes.delete(stringsinkholeID, SinkholeDeleteParams { account\_id } params, RequestOptionsoptions?): [SinkholeDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes%20%3E%20%28model%29%20sinkhole%5Fdelete%5Fresponse%20%3E%20%28schema%29)

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](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/create)

client.intel.sinkholes.ingresses.create(stringsinkholeID, IngressCreateParams { zone\_id, cidr } params, RequestOptionsoptions?): [IngressCreateResponse](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes.ingresses%20%3E%20%28model%29%20ingress%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id, cidr, created\_on, 3 more } 

POST/zones/{zone\_id}/intel/sinkholes/{sinkhole\_id}/ingresses

##### [Get an ingress rule](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/get)

client.intel.sinkholes.ingresses.get(stringingressID, IngressGetParams { zone\_id, sinkhole\_id } params, RequestOptionsoptions?): [IngressGetResponse](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes.ingresses%20%3E%20%28model%29%20ingress%5Fget%5Fresponse%20%3E%20%28schema%29) { id, cidr, created\_on, 3 more } 

GET/zones/{zone\_id}/intel/sinkholes/{sinkhole\_id}/ingresses/{ingress\_id}

##### [Update an ingress rule](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/update)

client.intel.sinkholes.ingresses.update(stringingressID, IngressUpdateParams { zone\_id, sinkhole\_id, cidr } params, RequestOptionsoptions?): [IngressUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes.ingresses%20%3E%20%28model%29%20ingress%5Fupdate%5Fresponse%20%3E%20%28schema%29)

PUT/zones/{zone\_id}/intel/sinkholes/{sinkhole\_id}/ingresses/{ingress\_id}

##### [Delete an ingress rule](https://developers.cloudflare.com/api/typescript/resources/intel/subresources/sinkholes/subresources/ingresses/methods/delete)

client.intel.sinkholes.ingresses.delete(stringingressID, IngressDeleteParams { zone\_id, sinkhole\_id } params, RequestOptionsoptions?): [IngressDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/intel#%28resource%29%20intel.sinkholes.ingresses%20%3E%20%28model%29%20ingress%5Fdelete%5Fresponse%20%3E%20%28schema%29)

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