# Regions

## List DLS regions for an account

`dls.regions.list(RegionListParams**kwargs)  -> SyncCursorPagination[RegionListResponse]`

**get** `/accounts/{account_id}/dls/regions`

List DLS regions for an account

### Parameters

- `account_id: int`

- `cursor: Optional[str]`

  Opaque token for cursor-based pagination. Omit for the first page. Pass the value from a previous response to fetch the next page.

- `per_page: Optional[int]`

- `type: Optional[Literal["managed", "custom"]]`

  Filter regions by type. Omit to return all regions.

  - `"managed"`

  - `"custom"`

### Returns

- `class RegionListResponse: …`

  - `id: str`

  - `created_on: datetime`

  - `modified_on: datetime`

  - `name: str`

  - `region_key: str`

  - `version: int`

  - `version_created_on: datetime`

### 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.dls.regions.list(
    account_id=0,
)
page = page.result[0]
print(page.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"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "created_on": "2019-12-27T18:11:19.117Z",
      "modified_on": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "region_key": "x",
      "version": 0,
      "version_created_on": "2019-12-27T18:11:19.117Z"
    }
  ],
  "result_info": {
    "count": 0,
    "cursor": "cursor",
    "per_page": 0
  },
  "success": true
}
```

## Get a DLS region

`dls.regions.get(strregion_id, RegionGetParams**kwargs)  -> RegionGetResponse`

**get** `/accounts/{account_id}/dls/regions/{region_id}`

Get a DLS region

### Parameters

- `account_id: int`

- `region_id: str`

  UUID of the region (custom or managed) or region_key of a managed region.

### Returns

- `class RegionGetResponse: …`

  - `id: str`

  - `created_on: datetime`

  - `modified_on: datetime`

  - `name: str`

  - `region_key: str`

  - `version: int`

  - `version_created_on: datetime`

### 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
)
region = client.dls.regions.get(
    region_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    account_id=0,
)
print(region.id)
```

#### Response

```json
{
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "created_on": "2019-12-27T18:11:19.117Z",
    "modified_on": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "region_key": "x",
    "version": 0,
    "version_created_on": "2019-12-27T18:11:19.117Z"
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ]
}
```

## Domain Types

### Region List Response

- `class RegionListResponse: …`

  - `id: str`

  - `created_on: datetime`

  - `modified_on: datetime`

  - `name: str`

  - `region_key: str`

  - `version: int`

  - `version_created_on: datetime`

### Region Get Response

- `class RegionGetResponse: …`

  - `id: str`

  - `created_on: datetime`

  - `modified_on: datetime`

  - `name: str`

  - `region_key: str`

  - `version: int`

  - `version_created_on: datetime`