---
title: Sinkholes
---

[Skip to content](#_top)

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

[Intel](https://developers.cloudflare.com/api/python/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/python/resources/intel/subresources/sinkholes/methods/list)

intel.sinkholes.list(SinkholeListParams\*\*kwargs) -> SyncSinglePage\[[Sinkhole](<https://developers.cloudflare.com/api/python/resources/intel#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>)]

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

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

intel.sinkholes.get(strsinkhole\_id, SinkholeGetParams\*\*kwargs) -> [Sinkhole](<https://developers.cloudflare.com/api/python/resources/intel#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>)

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

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

intel.sinkholes.create(SinkholeCreateParams\*\*kwargs) -> [Sinkhole](<https://developers.cloudflare.com/api/python/resources/intel#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>)

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

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

intel.sinkholes.update(strsinkhole\_id, SinkholeUpdateParams\*\*kwargs) -> object

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

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

intel.sinkholes.delete(strsinkhole\_id, SinkholeDeleteParams\*\*kwargs) -> object

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

##### ModelsExpand Collapse

<details>

<summary>

class Sinkhole: …

</summary>

id: Optional\[str]

The unique identifier for the sinkhole.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

account\_tag: Optional\[str]

The account tag that owns this sinkhole.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20account_tag">Link to this property</a>

created\_on: Optional\[datetime]

The date and time when the sinkhole was created.

formatdate-time

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

modified\_on: Optional\[datetime]

The date and time when the sinkhole was last modified.

formatdate-time

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

name: Optional\[str]

The name of the sinkhole.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

r2\_bucket: Optional\[str]

The name of the R2 bucket to store results.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20r2_bucket">Link to this property</a>

r2\_id: Optional\[str]

The id of the R2 instance.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20r2_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>)

#### SinkholesIngresses

##### [Create an ingress rule](https://developers.cloudflare.com/api/python/resources/intel/subresources/sinkholes/subresources/ingresses/methods/create)

intel.sinkholes.ingresses.create(strsinkhole\_id, IngressCreateParams\*\*kwargs) -> [IngressCreateResponse](<https://developers.cloudflare.com/api/python/resources/intel#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)>)

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

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

intel.sinkholes.ingresses.get(stringress\_id, IngressGetParams\*\*kwargs) -> [IngressGetResponse](<https://developers.cloudflare.com/api/python/resources/intel#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)>)

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

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

intel.sinkholes.ingresses.update(stringress\_id, IngressUpdateParams\*\*kwargs) -> object

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

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

intel.sinkholes.ingresses.delete(stringress\_id, IngressDeleteParams\*\*kwargs) -> object

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

##### ModelsExpand Collapse

<details>

<summary>

class IngressCreateResponse: …

</summary>

id: Optional\[str]

The unique identifier for the ingress rule.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

cidr: Optional\[str]

The CIDR block for the ingress rule.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)%20%3E%20(property)%20cidr">Link to this property</a>

created\_on: Optional\[datetime]

The date and time when the ingress rule was created.

formatdate-time

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

modified\_on: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

sinkhole\_id: Optional\[str]

The sinkhole this ingress rule belongs to.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)%20%3E%20(property)%20sinkhole_id">Link to this property</a>

zone\_tag: Optional\[str]

The zone tag associated with this ingress rule.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)%20%3E%20(property)%20zone_tag">Link to this property</a>

</details>

[Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_create_response%20%3E%20(schema)>)

<details>

<summary>

class IngressGetResponse: …

</summary>

id: Optional\[str]

The unique identifier for the ingress rule.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

cidr: Optional\[str]

The CIDR block for the ingress rule.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)%20%3E%20(property)%20cidr">Link to this property</a>

created\_on: Optional\[datetime]

The date and time when the ingress rule was created.

formatdate-time

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

modified\_on: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

sinkhole\_id: Optional\[str]

The sinkhole this ingress rule belongs to.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)%20%3E%20(property)%20sinkhole_id">Link to this property</a>

zone\_tag: Optional\[str]

The zone tag associated with this ingress rule.

<a href="#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)%20%3E%20(property)%20zone_tag">Link to this property</a>

</details>

[Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)>)