---
title: Update a sinkhole
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Intel](https://developers.cloudflare.com/api/python/resources/intel)

[Sinkholes](https://developers.cloudflare.com/api/python/resources/intel/subresources/sinkholes)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Update a sinkhole

intel.sinkholes.update(strsinkhole\_id, SinkholeUpdateParams\*\*kwargs) -> object

PUT/accounts/{account\_id}/intel/sinkholes/{sinkhole\_id}

Replaces the name or R2 configuration of the specified sinkhole. This is a full replacement. All fields, including r2\_secret, must be re-supplied. Omitting r2\_secret overwrites the stored value with an empty string.

##### 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

An identifier for the resource.

maxLength32

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

sinkhole\_id: str

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20sinkhole_id%20%3E%20(schema)>)

name: str

The name of the sinkhole.

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)

r2\_bucket: Optional\[str]

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

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20r2_bucket%20%3E%20(schema)>)

r2\_id: Optional\[str]

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

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20r2_id%20%3E%20(schema)>)

r2\_secret: Optional\[str]

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

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20r2_secret%20%3E%20(schema)>)

##### ReturnsExpand Collapse

object

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20result>)

### Update a sinkhole

Python

HTTPTypeScriptPythonGoTerraform

```
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)
```

200 example

```
{
  "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

200 example

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