# Logs

# Log Explorer

# Query

## Run a log query

`logs.log_explorer.query.sql(QuerySqlParams**kwargs)  -> SyncSinglePage[QuerySqlResponse]`

**post** `/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/query/sql`

Run a SQL query against account or zone-level datasets.

Timestamp fields are RFC3339 strings. Filter with:
WHERE {timestamp_field} >= now() - INTERVAL '30' DAY
WHERE {timestamp_field} >= '2026-04-01T00:00:00Z'
WHERE {timestamp_field} BETWEEN '2026-04-01T00:00:00Z' AND '2026-04-30T23:59:59Z'

Check /account or zones/{account or zone_id}/logs/explorer/datasets to see enabled account or zone level datasets.
Zone-level datasets will not appear here.
Check /account or zones/{account or zone_id}/logs/explorer/datasets/available for the schemas, and the name of the timestamp fields.

For zone-level datasets use the zone-scoped endpoint: POST /zones/{zone_id}/logs/explorer/query/sql

For more information about the datasets, and the meaning of each field, check out https://edgetunnel-b2h.pages.dev/logs/logpush/logpush-job/datasets/

### Parameters

- `body: FileTypes`

  SQL query to execute.

- `account_id: Optional[str]`

  The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

- `zone_id: Optional[str]`

  The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

### Returns

- `Dict[str, object]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.logs.log_explorer.query.sql(
    body=b"Example data",
    account_id="account_id",
)
page = page.result[0]
print(page)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": [
    {
      "foo": "bar"
    }
  ]
}
```

## Domain Types

### Query Sql Response

- `Dict[str, object]`

# Datasets

## List account or zone datasets

`logs.log_explorer.datasets.list(DatasetListParams**kwargs)  -> SyncSinglePage[DatasetSummary]`

**get** `/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets`

Returns all Log Explorer datasets configured for the account or zone.

Pass `include_zones=true` to also include zone-level datasets that
belong to this account or zone. List responses omit the `fields` property;
use the single-dataset endpoint to retrieve field configuration.

### Parameters

- `account_id: Optional[str]`

  The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

- `zone_id: Optional[str]`

  The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

- `include_zones: Optional[bool]`

  Set to true to include zone-scoped datasets belonging to this account.

### Returns

- `class DatasetSummary: …`

  A Log Explorer dataset summary. List endpoints return this type and omit
  field configuration; use the single-dataset endpoint to retrieve it.

  - `created_at: datetime`

    RFC3339 timestamp recording when the API created this dataset.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `dataset_id: str`

    Unique dataset ID.

  - `enabled: bool`

    Whether log ingest is currently active for this dataset.

  - `object_id: str`

    Public ID of the account or zone that owns this dataset.

  - `object_type: Literal["account", "zone"]`

    Whether this dataset belongs to an account or a zone.

    - `"account"`

    - `"zone"`

  - `updated_at: datetime`

    RFC3339 timestamp recording when the API last updated this dataset.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.logs.log_explorer.datasets.list(
    account_id="account_id",
)
page = page.result[0]
print(page.dataset_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "dataset": "dataset",
      "dataset_id": "dataset_id",
      "enabled": true,
      "object_id": "object_id",
      "object_type": "account",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ]
}
```

## Get an account or zone dataset

`logs.log_explorer.datasets.get(strdataset_id, DatasetGetParams**kwargs)  -> Dataset`

**get** `/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/{dataset_id}`

Retrieve a single Log Explorer dataset by ID for the account or zone.

### Parameters

- `dataset_id: str`

- `account_id: Optional[str]`

  The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

- `zone_id: Optional[str]`

  The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

### Returns

- `class Dataset: …`

  A Log Explorer dataset summary. List endpoints return this type and omit
  field configuration; use the single-dataset endpoint to retrieve it.

  - `created_at: datetime`

    RFC3339 timestamp recording when the API created this dataset.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `dataset_id: str`

    Unique dataset ID.

  - `enabled: bool`

    Whether log ingest is currently active for this dataset.

  - `object_id: str`

    Public ID of the account or zone that owns this dataset.

  - `object_type: Literal["account", "zone"]`

    Whether this dataset belongs to an account or a zone.

    - `"account"`

    - `"zone"`

  - `updated_at: datetime`

    RFC3339 timestamp recording when the API last updated this dataset.

  - `fields: Optional[List[Field]]`

    The field configuration for this dataset.

    - `enabled: bool`

      Whether the API includes this field in log ingest.

    - `name: str`

      Field name in lowercase.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
dataset = client.logs.log_explorer.datasets.get(
    dataset_id="dataset_id",
    account_id="account_id",
)
print(dataset.dataset_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "dataset": "dataset",
    "dataset_id": "dataset_id",
    "enabled": true,
    "object_id": "object_id",
    "object_type": "account",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "fields": [
      {
        "enabled": true,
        "name": "name"
      }
    ]
  }
}
```

## Create an account or zone dataset

`logs.log_explorer.datasets.create(DatasetCreateParams**kwargs)  -> Dataset`

**post** `/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets`

Create a new Log Explorer dataset for the account or zone.

Use the `/account or zones/{account or zone_id}/logs/explorer/datasets/available` endpoint
to list dataset types you can create along with their available fields.

The `fields` property is optional. If not specified, all available fields
will be enabled.

For zone-level datasets use the zone-scoped endpoint: POST /zones/{zone_id}/logs/explorer/datasets

For dataset field definitions, see: https://edgetunnel-b2h.pages.dev/logs/logpush/logpush-job/datasets/

### Parameters

- `dataset: str`

  Dataset type name to create (e.g. `http_requests`).

- `account_id: Optional[str]`

  The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

- `zone_id: Optional[str]`

  The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

- `fields: Optional[Iterable[Field]]`

  Controls which fields the API ingests. Defaults to all available
  fields when absent.

  - `enabled: bool`

    Whether the API includes this field in log ingest.

  - `name: str`

    Field name in lowercase.

### Returns

- `class Dataset: …`

  A Log Explorer dataset summary. List endpoints return this type and omit
  field configuration; use the single-dataset endpoint to retrieve it.

  - `created_at: datetime`

    RFC3339 timestamp recording when the API created this dataset.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `dataset_id: str`

    Unique dataset ID.

  - `enabled: bool`

    Whether log ingest is currently active for this dataset.

  - `object_id: str`

    Public ID of the account or zone that owns this dataset.

  - `object_type: Literal["account", "zone"]`

    Whether this dataset belongs to an account or a zone.

    - `"account"`

    - `"zone"`

  - `updated_at: datetime`

    RFC3339 timestamp recording when the API last updated this dataset.

  - `fields: Optional[List[Field]]`

    The field configuration for this dataset.

    - `enabled: bool`

      Whether the API includes this field in log ingest.

    - `name: str`

      Field name in lowercase.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
dataset = client.logs.log_explorer.datasets.create(
    dataset="dataset",
    account_id="account_id",
)
print(dataset.dataset_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "dataset": "dataset",
    "dataset_id": "dataset_id",
    "enabled": true,
    "object_id": "object_id",
    "object_type": "account",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "fields": [
      {
        "enabled": true,
        "name": "name"
      }
    ]
  }
}
```

## Update an account or zone dataset

`logs.log_explorer.datasets.update(strdataset_id, DatasetUpdateParams**kwargs)  -> Dataset`

**put** `/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/{dataset_id}`

Updates the enabled state and/or field configuration of an account or zone dataset.

### Parameters

- `dataset_id: str`

- `enabled: bool`

  Whether to enable or disable log ingest for this dataset.

- `account_id: Optional[str]`

  The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

- `zone_id: Optional[str]`

  The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

- `fields: Optional[Iterable[Field]]`

  Controls which fields the API ingests after the update. Defaults
  to all available fields when absent.

  - `enabled: bool`

    Whether the API includes this field in log ingest.

  - `name: str`

    Field name in lowercase.

### Returns

- `class Dataset: …`

  A Log Explorer dataset summary. List endpoints return this type and omit
  field configuration; use the single-dataset endpoint to retrieve it.

  - `created_at: datetime`

    RFC3339 timestamp recording when the API created this dataset.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `dataset_id: str`

    Unique dataset ID.

  - `enabled: bool`

    Whether log ingest is currently active for this dataset.

  - `object_id: str`

    Public ID of the account or zone that owns this dataset.

  - `object_type: Literal["account", "zone"]`

    Whether this dataset belongs to an account or a zone.

    - `"account"`

    - `"zone"`

  - `updated_at: datetime`

    RFC3339 timestamp recording when the API last updated this dataset.

  - `fields: Optional[List[Field]]`

    The field configuration for this dataset.

    - `enabled: bool`

      Whether the API includes this field in log ingest.

    - `name: str`

      Field name in lowercase.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
dataset = client.logs.log_explorer.datasets.update(
    dataset_id="dataset_id",
    enabled=True,
    account_id="account_id",
)
print(dataset.dataset_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "dataset": "dataset",
    "dataset_id": "dataset_id",
    "enabled": true,
    "object_id": "object_id",
    "object_type": "account",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "fields": [
      {
        "enabled": true,
        "name": "name"
      }
    ]
  }
}
```

## Domain Types

### Create Request

- `class CreateRequest: …`

  - `dataset: str`

    Dataset type name to create (e.g. `http_requests`).

  - `fields: Optional[List[Field]]`

    Controls which fields the API ingests. Defaults to all available
    fields when absent.

    - `enabled: bool`

      Whether the API includes this field in log ingest.

    - `name: str`

      Field name in lowercase.

### Dataset

- `class Dataset: …`

  A Log Explorer dataset summary. List endpoints return this type and omit
  field configuration; use the single-dataset endpoint to retrieve it.

  - `created_at: datetime`

    RFC3339 timestamp recording when the API created this dataset.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `dataset_id: str`

    Unique dataset ID.

  - `enabled: bool`

    Whether log ingest is currently active for this dataset.

  - `object_id: str`

    Public ID of the account or zone that owns this dataset.

  - `object_type: Literal["account", "zone"]`

    Whether this dataset belongs to an account or a zone.

    - `"account"`

    - `"zone"`

  - `updated_at: datetime`

    RFC3339 timestamp recording when the API last updated this dataset.

  - `fields: Optional[List[Field]]`

    The field configuration for this dataset.

    - `enabled: bool`

      Whether the API includes this field in log ingest.

    - `name: str`

      Field name in lowercase.

### Dataset Summary

- `class DatasetSummary: …`

  A Log Explorer dataset summary. List endpoints return this type and omit
  field configuration; use the single-dataset endpoint to retrieve it.

  - `created_at: datetime`

    RFC3339 timestamp recording when the API created this dataset.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `dataset_id: str`

    Unique dataset ID.

  - `enabled: bool`

    Whether log ingest is currently active for this dataset.

  - `object_id: str`

    Public ID of the account or zone that owns this dataset.

  - `object_type: Literal["account", "zone"]`

    Whether this dataset belongs to an account or a zone.

    - `"account"`

    - `"zone"`

  - `updated_at: datetime`

    RFC3339 timestamp recording when the API last updated this dataset.

### Update Request

- `class UpdateRequest: …`

  - `enabled: bool`

    Whether to enable or disable log ingest for this dataset.

  - `fields: Optional[List[Field]]`

    Controls which fields the API ingests after the update. Defaults
    to all available fields when absent.

    - `enabled: bool`

      Whether the API includes this field in log ingest.

    - `name: str`

      Field name in lowercase.

# Available

## List available account or zone datasets

`logs.log_explorer.datasets.available.list(AvailableListParams**kwargs)  -> SyncSinglePage[AvailableDataset]`

**get** `/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/available`

Returns all dataset types that this account or zone can create. Each entry
includes the dataset schema and timestamp field.

The schema shows all possible fields for a dataset. However, not all
fields may be available for your account or zone. When creating or updating a
dataset, only fields available to your account or zone can be enabled. If you
request a field that is not available, you will receive an error.

### Parameters

- `account_id: Optional[str]`

  The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

- `zone_id: Optional[str]`

  The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

### Returns

- `class AvailableDataset: …`

  A dataset type that the account or zone can create.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `object_type: Literal["account", "zone"]`

    Whether this dataset type is account-scoped or zone-scoped.

    - `"account"`

    - `"zone"`

  - `schema: Schema`

    JSON Schema that describes the fields this dataset exposes.

    - `properties: Optional[Dict[str, object]]`

    - `required: Optional[List[str]]`

    - `type: Optional[Literal["object"]]`

      - `"object"`

  - `timestamp_field: str`

    The primary timestamp field name for this dataset.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.logs.log_explorer.datasets.available.list(
    account_id="account_id",
)
page = page.result[0]
print(page.dataset)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "success": true,
  "result": [
    {
      "dataset": "dataset",
      "object_type": "account",
      "schema": {
        "properties": {
          "foo": "bar"
        },
        "required": [
          "string"
        ],
        "type": "object"
      },
      "timestamp_field": "timestamp_field"
    }
  ]
}
```

## Domain Types

### Available Dataset

- `class AvailableDataset: …`

  A dataset type that the account or zone can create.

  - `dataset: str`

    Dataset type name (e.g. `http_requests`).

  - `object_type: Literal["account", "zone"]`

    Whether this dataset type is account-scoped or zone-scoped.

    - `"account"`

    - `"zone"`

  - `schema: Schema`

    JSON Schema that describes the fields this dataset exposes.

    - `properties: Optional[Dict[str, object]]`

    - `required: Optional[List[str]]`

    - `type: Optional[Literal["object"]]`

      - `"object"`

  - `timestamp_field: str`

    The primary timestamp field name for this dataset.

### Available List

- `class AvailableList: …`

  - `errors: List[ResponseInfo]`

    - `code: int`

    - `message: str`

    - `documentation_url: Optional[str]`

    - `source: Optional[Source]`

      - `pointer: Optional[str]`

  - `messages: List[str]`

  - `success: bool`

  - `result: Optional[List[AvailableDataset]]`

    - `dataset: str`

      Dataset type name (e.g. `http_requests`).

    - `object_type: Literal["account", "zone"]`

      Whether this dataset type is account-scoped or zone-scoped.

      - `"account"`

      - `"zone"`

    - `schema: Schema`

      JSON Schema that describes the fields this dataset exposes.

      - `properties: Optional[Dict[str, object]]`

      - `required: Optional[List[str]]`

      - `type: Optional[Literal["object"]]`

        - `"object"`

    - `timestamp_field: str`

      The primary timestamp field name for this dataset.

# Control

# Retention

## Get log retention flag

`logs.control.retention.get(RetentionGetParams**kwargs)  -> RetentionGetResponse`

**get** `/zones/{zone_id}/logs/control/retention/flag`

Gets log retention flag for Logpull API.

### Parameters

- `zone_id: str`

  Identifier.

### Returns

- `class RetentionGetResponse: …`

  - `flag: Optional[bool]`

    The log retention flag for Logpull API.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
retention = client.logs.control.retention.get(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(retention.flag)
```

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

## Update log retention flag

`logs.control.retention.create(RetentionCreateParams**kwargs)  -> RetentionCreateResponse`

**post** `/zones/{zone_id}/logs/control/retention/flag`

Updates log retention flag for Logpull API.

### Parameters

- `zone_id: str`

  Identifier.

- `flag: Optional[bool]`

  The log retention flag for Logpull API.

### Returns

- `class RetentionCreateResponse: …`

  - `flag: Optional[bool]`

    The log retention flag for Logpull API.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
retention = client.logs.control.retention.create(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(retention.flag)
```

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

## Domain Types

### Retention Get Response

- `class RetentionGetResponse: …`

  - `flag: Optional[bool]`

    The log retention flag for Logpull API.

### Retention Create Response

- `class RetentionCreateResponse: …`

  - `flag: Optional[bool]`

    The log retention flag for Logpull API.

# Cmb

# Config

## Get CMB config

`logs.control.cmb.config.get(ConfigGetParams**kwargs)  -> CmbConfig`

**get** `/accounts/{account_id}/logs/control/cmb/config`

Gets CMB config.

### Parameters

- `account_id: str`

  Identifier.

### Returns

- `class CmbConfig: …`

  - `allow_out_of_region_access: Optional[bool]`

    Allow out of region access

  - `regions: Optional[str]`

    Name of the region.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
cmb_config = client.logs.control.cmb.config.get(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(cmb_config.allow_out_of_region_access)
```

#### 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": {
    "allow_out_of_region_access": false,
    "regions": "eu"
  }
}
```

## Update CMB config

`logs.control.cmb.config.create(ConfigCreateParams**kwargs)  -> CmbConfig`

**post** `/accounts/{account_id}/logs/control/cmb/config`

Updates CMB config.

### Parameters

- `account_id: str`

  Identifier.

- `allow_out_of_region_access: Optional[bool]`

  Allow out of region access

- `regions: Optional[str]`

  Name of the region.

### Returns

- `class CmbConfig: …`

  - `allow_out_of_region_access: Optional[bool]`

    Allow out of region access

  - `regions: Optional[str]`

    Name of the region.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
cmb_config = client.logs.control.cmb.config.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(cmb_config.allow_out_of_region_access)
```

#### 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": {
    "allow_out_of_region_access": false,
    "regions": "eu"
  }
}
```

## Delete CMB config

`logs.control.cmb.config.delete(ConfigDeleteParams**kwargs)  -> object`

**delete** `/accounts/{account_id}/logs/control/cmb/config`

Deletes CMB config.

### Parameters

- `account_id: str`

  Identifier.

### Returns

- `object`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
config = client.logs.control.cmb.config.delete(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(config)
```

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

## Domain Types

### Cmb Config

- `class CmbConfig: …`

  - `allow_out_of_region_access: Optional[bool]`

    Allow out of region access

  - `regions: Optional[str]`

    Name of the region.

# RayID

## Get logs RayIDs

`logs.rayid.get(strrayid, RayIDGetParams**kwargs)  -> RayIDGetResponse`

**get** `/zones/{zone_id}/logs/rayids/{ray_id}`

The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).

### Parameters

- `zone_id: str`

  Identifier.

- `rayid: str`

  Ray identifier.

- `fields: Optional[str]`

  The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.

- `timestamps: Optional[Literal["unix", "unixnano", "rfc3339"]]`

  By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.

  - `"unix"`

  - `"unixnano"`

  - `"rfc3339"`

### Returns

- `Union[str, object]`

  - `str`

  - `object`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
rayid = client.logs.rayid.get(
    rayid="41ddf1740f67442d",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(rayid)
```

#### Response

```json
"{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}"
```

## Domain Types

### RayID Get Response

- `Union[str, object]`

  - `str`

  - `object`

# Received

## Get logs received

`logs.received.get(ReceivedGetParams**kwargs)  -> ReceivedGetResponse`

**get** `/zones/{zone_id}/logs/received`

The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.

### Parameters

- `zone_id: str`

  Identifier.

- `end: Union[str, int]`

  Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.

  - `str`

  - `int`

- `count: Optional[int]`

  When `?count=` is provided, the response will contain up to `count` results. Since results are not sorted, you are likely to get different data for repeated requests. `count` must be an integer > 0.

- `fields: Optional[str]`

  The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.

- `sample: Optional[float]`

  When `?sample=` is provided, a sample of matching records is returned. If `sample=0.1` then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When `?count=` is also specified, `count` is applied to the number of returned records, not the sampled records. So, with `sample=0.05` and `count=7`, when there is a total of 100 records available, approximately five will be returned. When there are 1000 records, seven will be returned. When there are 10,000 records, seven will be returned.

- `start: Optional[Union[str, int]]`

  Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.

  - `str`

  - `int`

- `timestamps: Optional[Literal["unix", "unixnano", "rfc3339"]]`

  By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.

  - `"unix"`

  - `"unixnano"`

  - `"rfc3339"`

### Returns

- `Union[str, object]`

  - `str`

  - `object`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
received = client.logs.received.get(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    end="2018-05-20T10:01:00Z",
)
print(received)
```

#### Response

```json
"{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}"
```

## Domain Types

### Received Get Response

- `Union[str, object]`

  - `str`

  - `object`

# Fields

## List fields

`logs.received.fields.get(FieldGetParams**kwargs)  -> FieldGetResponse`

**get** `/zones/{zone_id}/logs/received/fields`

Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.

### Parameters

- `zone_id: str`

  Identifier.

### Returns

- `class FieldGetResponse: …`

  - `key: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
field = client.logs.received.fields.get(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(field.key)
```

#### Response

```json
{
  "key": "value"
}
```

## Domain Types

### Field Get Response

- `class FieldGetResponse: …`

  - `key: Optional[str]`