Skip to content
Start here

Sinkholes

List sinkholes owned by this account
GET/accounts/{account_id}/intel/sinkholes
Get a sinkhole
GET/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Create a new sinkhole for your account
POST/accounts/{account_id}/intel/sinkholes
Update a sinkhole
PUT/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Delete a sinkhole
DELETE/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
ModelsExpand Collapse
Sinkhole object { id, account_tag, created_on, 4 more }
id: optional string

The unique identifier for the sinkhole.

account_tag: optional string

The account tag that owns this sinkhole.

created_on: optional string

The date and time when the sinkhole was created.

formatdate-time
modified_on: optional string

The date and time when the sinkhole was last modified.

formatdate-time
name: optional string

The name of the sinkhole.

r2_bucket: optional string

The name of the R2 bucket to store results.

r2_id: optional string

The id of the R2 instance.

SinkholeUpdateResponse = unknown
SinkholeDeleteResponse = unknown

SinkholesIngresses

Create an ingress rule
POST/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses
Get an ingress rule
GET/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Update an ingress rule
PUT/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Delete an ingress rule
DELETE/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
ModelsExpand Collapse
IngressCreateResponse object { id, cidr, created_on, 3 more }
id: optional string

The unique identifier for the ingress rule.

cidr: optional string

The CIDR block for the ingress rule.

created_on: optional string

The date and time when the ingress rule was created.

formatdate-time
modified_on: optional string

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

formatdate-time
sinkhole_id: optional string

The sinkhole this ingress rule belongs to.

zone_tag: optional string

The zone tag associated with this ingress rule.

IngressGetResponse object { id, cidr, created_on, 3 more }
id: optional string

The unique identifier for the ingress rule.

cidr: optional string

The CIDR block for the ingress rule.

created_on: optional string

The date and time when the ingress rule was created.

formatdate-time
modified_on: optional string

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

formatdate-time
sinkhole_id: optional string

The sinkhole this ingress rule belongs to.

zone_tag: optional string

The zone tag associated with this ingress rule.

IngressUpdateResponse = unknown
IngressDeleteResponse = unknown