Create an ingress rule

client.Intel.Sinkholes.Ingresses.New(ctx, sinkholeID, params) (*SinkholeIngressNewResponse, error)

POST/zones/{zone_id}/intel/sinkholes/{sinkhole_id}/ingresses

Create a new ingress rule for the specified sinkhole. The CIDR block must be a Cloudflare BYOIP associated with your account. The zone_id must be a zone with the ability to create Spectrum Apps. The sinkhole must belong to the same account as the zone.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Intel Write

ParametersExpand Collapse

sinkholeID string

params SinkholeIngressNewParams

ZoneID param.Field[string]

Path param: An identifier for the resource.

maxLength32

CIDR param.Field[string]

Body param: The CIDR block for the ingress rule in IPv4 or IPv6 notation (e.g., 192.0.2.0/24). Provide a Cloudflare BYOIP CIDR that your account owns.

ReturnsExpand Collapse

type SinkholeIngressNewResponse struct{…}

ID stringOptional

The unique identifier for the ingress rule.

CIDR stringOptional

The CIDR block for the ingress rule.

CreatedOn TimeOptional

The date and time when the ingress rule was created.

formatdate-time

ModifiedOn TimeOptional

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

formatdate-time

SinkholeID stringOptional

The sinkhole this ingress rule belongs to.

ZoneTag stringOptional

The zone tag associated with this ingress rule.

Create an ingress rule

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/intel"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  ingress, err := client.Intel.Sinkholes.Ingresses.New(
    context.TODO(),
    "93defa6e909e464e8c89a85859f36d3c",
    intel.SinkholeIngressNewParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      CIDR: cloudflare.F("cidr"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", ingress.ID)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "de32ae5203724ed08dcc26e971a4d22f",
    "cidr": "192.0.2.0/24",
    "created_on": "2023-06-01T10:00:00Z",
    "modified_on": "2023-06-15T14:30:00Z",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c",
    "zone_tag": "4c961e9d94f40aa922775483b9ee18cf"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "de32ae5203724ed08dcc26e971a4d22f",
    "cidr": "192.0.2.0/24",
    "created_on": "2023-06-01T10:00:00Z",
    "modified_on": "2023-06-15T14:30:00Z",
    "sinkhole_id": "93defa6e909e464e8c89a85859f36d3c",
    "zone_tag": "4c961e9d94f40aa922775483b9ee18cf"
  }
}