Skip to content
Cloudflare API
Start here
API Reference
Intel

Sinkholes

List sinkholes owned by this account
client.Intel.Sinkholes.List(ctx, query) (*SinglePage[Sinkhole], error)
GET/accounts/{account_id}/intel/sinkholes
Get a sinkhole
client.Intel.Sinkholes.Get(ctx, sinkholeID, query) (*Sinkhole, error)
GET/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Create a new sinkhole for your account
client.Intel.Sinkholes.New(ctx, params) (*Sinkhole, error)
POST/accounts/{account_id}/intel/sinkholes
Update a sinkhole
client.Intel.Sinkholes.Update(ctx, sinkholeID, params) (*SinkholeUpdateResponse, error)
PUT/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
Delete a sinkhole
client.Intel.Sinkholes.Delete(ctx, sinkholeID, body) (*SinkholeDeleteResponse, error)
DELETE/accounts/{account_id}/intel/sinkholes/{sinkhole_id}
ModelsExpand Collapse
type Sinkhole struct{…}
ID stringOptional

The unique identifier for the sinkhole.

AccountTag stringOptional

The account tag that owns this sinkhole.

CreatedOn TimeOptional

The date and time when the sinkhole was created.

formatdate-time
ModifiedOn TimeOptional

The date and time when the sinkhole was last modified.

formatdate-time
Name stringOptional

The name of the sinkhole.

R2Bucket stringOptional

The name of the R2 bucket to store results.

R2ID stringOptional

The id of the R2 instance.

SinkholesIngresses

Create an ingress rule
client.Intel.Sinkholes.Ingresses.New(ctx, sinkholeID, params) (*SinkholeIngressNewResponse, error)
POST/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses
Get an ingress rule
client.Intel.Sinkholes.Ingresses.Get(ctx, sinkholeID, ingressID, query) (*SinkholeIngressGetResponse, error)
GET/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Update an ingress rule
client.Intel.Sinkholes.Ingresses.Update(ctx, sinkholeID, ingressID, params) (*SinkholeIngressUpdateResponse, error)
PUT/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}
Delete an ingress rule
client.Intel.Sinkholes.Ingresses.Delete(ctx, sinkholeID, ingressID, body) (*SinkholeIngressDeleteResponse, error)
DELETE/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses/{ingress_id}