Update a sinkhole

intel.sinkholes.update(, ) -> object

PUT/accounts/{account_id}/intel/sinkholes/{sinkhole_id}

Update the name or R2 configuration of the specified sinkhole.

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

account_id: str

Identifier.

maxLength32

sinkhole_id: str

name: str

The name of the sinkhole.

r2_bucket: Optional[str]

The name of the R2 bucket to store results. Required if you want to store large request bodies in R2.

r2_id: Optional[str]

The id of the R2 instance. Required if you want to store large request bodies in R2.

r2_secret: Optional[str]

The secret key for the R2 API token. Required if you want to store large request bodies in R2.

ReturnsExpand Collapse

object

Update a sinkhole

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
sinkhole = client.intel.sinkholes.update(
    sinkhole_id="93defa6e909e464e8c89a85859f36d3c",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    name="name",
)
print(sinkhole)

{
  "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": {}
}

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": {}
}