--- title: Sinkholes --- [Skip to content](#_top) [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]() {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]() {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]() {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]() 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]() 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. Link to this property account\_tag?: string The account tag that owns this sinkhole. Link to this property created\_on?: string The date and time when the sinkhole was created. formatdate-time Link to this property modified\_on?: string The date and time when the sinkhole was last modified. formatdate-time Link to this property name?: string The name of the sinkhole. Link to this property r2\_bucket?: string The name of the R2 bucket to store results. Link to this property r2\_id?: string The id of the R2 instance. Link to this property

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>) SinkholeUpdateResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole_update_response%20%3E%20(schema)>) SinkholeDeleteResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole_delete_response%20%3E%20(schema)>) #### 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]() {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]() {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]() 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]() 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. Link to this property cidr?: string The CIDR block for the ingress rule. Link to this property created\_on?: string The date and time when the ingress rule was created. formatdate-time Link to this property modified\_on?: string The date and time when the ingress rule was last modified. formatdate-time Link to this property sinkhole\_id?: string The sinkhole this ingress rule belongs to. Link to this property zone\_tag?: string The zone tag associated with this ingress rule. Link to this property

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

IngressGetResponse {id, cidr, created\_on, 3 more }

[Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_get_response%20%3E%20(schema)>) IngressUpdateResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_update_response%20%3E%20(schema)>) IngressDeleteResponse = unknown [Link to this property](<#(resource)%20intel.sinkholes.ingresses%20%3E%20(model)%20ingress_delete_response%20%3E%20(schema)>)