---
title: Create a new sinkhole for your account
---

[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**

# Create a new sinkhole for your account

intel.sinkholes.create(SinkholeCreateParams\*\*kwargs) -> [Sinkhole](<https://developers.cloudflare.com/api/python/resources/intel#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>)

POST/accounts/{account\_id}/intel/sinkholes

Create a new sinkhole. Logs of large request bodies will be truncated, but the full request body can be recorded in R2. If you wish to record large request bodies in R2, include the R2 key ID, key secret, and bucket name in the request body.

##### 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)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

name: str

The name of the sinkhole.

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(method)%20create%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)%20create%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)%20create%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)%20create%20%3E%20(params)%20default%20%3E%20(param)%20r2_secret%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class Sinkhole: …

</summary>

id: Optional\[str]

The unique identifier for the sinkhole.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

account\_tag: Optional\[str]

The account tag that owns this sinkhole.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20account_tag">Link to this property</a>

created\_on: Optional\[datetime]

The date and time when the sinkhole was created.

formatdate-time

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

modified\_on: Optional\[datetime]

The date and time when the sinkhole was last modified.

formatdate-time

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

name: Optional\[str]

The name of the sinkhole.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

r2\_bucket: Optional\[str]

The name of the R2 bucket to store results.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20r2_bucket">Link to this property</a>

r2\_id: Optional\[str]

The id of the R2 instance.

<a href="#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)%20%3E%20(property)%20r2_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20intel.sinkholes%20%3E%20(model)%20sinkhole%20%3E%20(schema)>)

### Create a new sinkhole for your account

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.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    name="name",
)
print(sinkhole.id)
```

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": {
    "id": "93defa6e909e464e8c89a85859f36d3c",
    "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
    "created_on": "2023-05-12T12:21:56.777653Z",
    "modified_on": "2023-06-18T03:13:34.123321Z",
    "name": "my_sinkhole",
    "r2_bucket": "my_bucket",
    "r2_id": "example_r2_id"
  }
}
```

##### 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": {
    "id": "93defa6e909e464e8c89a85859f36d3c",
    "account_tag": "233f45e61fd1f7e21e1e154ede4q2859",
    "created_on": "2023-05-12T12:21:56.777653Z",
    "modified_on": "2023-06-18T03:13:34.123321Z",
    "name": "my_sinkhole",
    "r2_bucket": "my_bucket",
    "r2_id": "example_r2_id"
  }
}
```