Skip to content
Cloudflare API
Start here
API Reference
Intel

Sinkholes

List sinkholes owned by this account
intel.sinkholes.list(SinkholeListParams**kwargs) -> SyncSinglePage[Sinkhole]
GET/accounts/{account_id}/intel/sinkholes
Get a sinkhole
intel.sinkholes.get(strsinkhole_id, SinkholeGetParams**kwargs) -> Sinkhole
GET/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Create a new sinkhole for your account
intel.sinkholes.create(SinkholeCreateParams**kwargs) -> Sinkhole
POST/accounts/{account_id}/intel/sinkholes
Update a sinkhole
intel.sinkholes.update(strsinkhole_id, SinkholeUpdateParams**kwargs) -> object
PUT/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Delete a sinkhole
intel.sinkholes.delete(strsinkhole_id, SinkholeDeleteParams**kwargs) -> object
DELETE/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
ModelsExpand Collapse
class Sinkhole: …
id: Optional[str]

The unique identifier for the sinkhole.

account_tag: Optional[str]

The account tag that owns this sinkhole.

created_on: Optional[datetime]

The date and time when the sinkhole was created.

formatdate-time
modified_on: Optional[datetime]

The date and time when the sinkhole was last modified.

formatdate-time
name: Optional[str]

The name of the sinkhole.

r2_bucket: Optional[str]

The name of the R2 bucket to store results.

r2_id: Optional[str]

The id of the R2 instance.

SinkholesIngresses

Create an ingress rule
intel.sinkholes.ingresses.create(strsinkhole_id, IngressCreateParams**kwargs) -> IngressCreateResponse
POST/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses
Get an ingress rule
intel.sinkholes.ingresses.get(stringress_id, IngressGetParams**kwargs) -> IngressGetResponse
GET/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Update an ingress rule
intel.sinkholes.ingresses.update(stringress_id, IngressUpdateParams**kwargs) -> object
PUT/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Delete an ingress rule
intel.sinkholes.ingresses.delete(stringress_id, IngressDeleteParams**kwargs) -> object
DELETE/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
ModelsExpand Collapse
class IngressCreateResponse: …
id: Optional[str]

The unique identifier for the ingress rule.

cidr: Optional[str]

The CIDR block for the ingress rule.

created_on: Optional[datetime]

The date and time when the ingress rule was created.

formatdate-time
modified_on: Optional[datetime]

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

formatdate-time
sinkhole_id: Optional[str]

The sinkhole this ingress rule belongs to.

zone_tag: Optional[str]

The zone tag associated with this ingress rule.

class IngressGetResponse: …
id: Optional[str]

The unique identifier for the ingress rule.

cidr: Optional[str]

The CIDR block for the ingress rule.

created_on: Optional[datetime]

The date and time when the ingress rule was created.

formatdate-time
modified_on: Optional[datetime]

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

formatdate-time
sinkhole_id: Optional[str]

The sinkhole this ingress rule belongs to.

zone_tag: Optional[str]

The zone tag associated with this ingress rule.