# Sinkholes

## List sinkholes owned by this account

`client.intel.sinkholes.list(SinkholeListParamsparams, RequestOptionsoptions?): SinglePage<Sinkhole>`

**get** `/accounts/{account_id}/intel/sinkholes`

Lists sinkholes owned by the account for redirecting malicious traffic.

### Parameters

- `params: SinkholeListParams`

  - `account_id: string`

    Identifier.

### Returns

- `Sinkhole`

  - `id?: string`

    The unique identifier for the sinkhole.

  - `account_tag?: string`

    The account tag that owns this sinkhole.

  - `created_on?: string`

    The date and time when the sinkhole was created.

  - `modified_on?: string`

    The date and time when the sinkhole was last modified.

  - `name?: string`

    The name of the sinkhole.

  - `r2_bucket?: string`

    The name of the R2 bucket to store results.

  - `r2_id?: string`

    The id of the R2 instance.

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const sinkhole of client.intel.sinkholes.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(sinkhole.id);
}
```

#### Response

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

## Domain Types

### Sinkhole

- `Sinkhole`

  - `id?: string`

    The unique identifier for the sinkhole.

  - `account_tag?: string`

    The account tag that owns this sinkhole.

  - `created_on?: string`

    The date and time when the sinkhole was created.

  - `modified_on?: string`

    The date and time when the sinkhole was last modified.

  - `name?: string`

    The name of the sinkhole.

  - `r2_bucket?: string`

    The name of the R2 bucket to store results.

  - `r2_id?: string`

    The id of the R2 instance.