---
title: "List a project's zones, newest first"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: DNS API

`GET /v1/organizations/{orgId}/projects/{projectId}/zones`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `ListZones.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `ListZones.path.projectId` (string, required) — UUID or prefixed ID (prj_…)

## Query parameters

- `ListZones.query.limit` (integer, optional) — The page size. Out of range is 400, never a clamp.
  - min 1; max 100; default `20`
- `ListZones.query.cursor` (string, optional) — The previous page's nextCursor. Bound to the organization, the list and its filters.
- `ListZones.query.domainPrefix` (string, optional) — Only zones whose domain starts with this.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://dns-api.ezghcloud.com/v1/organizations/string/projects/string/zones \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://dns-api.ezghcloud.com/v1/organizations/string/projects/string/zones';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://dns-api.ezghcloud.com/v1/organizations/string/projects/string/zones"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

A page of zones.

#### Example

```json
{
  "nextCursor": "string",
  "zones": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "dnssec": {
        "dsRecords": [
          "string"
        ],
        "enabled": true
      },
      "domain": "string",
      "domainId": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "nameservers": [
        "string"
      ],
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "recordSetCount": 0,
      "region": "string",
      "resourceName": "string",
      "slug": "string",
      "status": "string",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "verification": {
        "lastCheckedAt": "2019-08-24T14:15:22Z",
        "txtName": "string",
        "txtValue": "string"
      }
    }
  ]
}
```

- `ListZones.response.200.nextCursor` (string | null, required)
- `ListZones.response.200.zones` (array<object>, required)
  - `ListZones.response.200.zones.createdAt` (string, required)
    - format `date-time`
  - `ListZones.response.200.zones.dnssec` (object, required)
    - `ListZones.response.200.zones.dnssec.dsRecords` (array<string>, required)
    - `ListZones.response.200.zones.dnssec.enabled` (boolean, required)
  - `ListZones.response.200.zones.domain` (string, required)
  - `ListZones.response.200.zones.domainId` (string | null, required) — The registered domain (dom_) this zone serves, or null. While it's set, the zone is deleted and its DNSSEC turned off from the domain, not here.
  - `ListZones.response.200.zones.id` (string, required)
    - format `uuid`
  - `ListZones.response.200.zones.name` (string, required) — The zone's domain.
  - `ListZones.response.200.zones.nameservers` (array<string>, required) — This zone's two nameservers.
  - `ListZones.response.200.zones.organizationId` (string, required)
    - format `uuid`
  - `ListZones.response.200.zones.projectId` (string | null, required)
    - format `uuid`
  - `ListZones.response.200.zones.recordSetCount` (integer, required)
  - `ListZones.response.200.zones.region` (string, required) — Empty: zones aren't regional.
  - `ListZones.response.200.zones.resourceName` (string, required)
  - `ListZones.response.200.zones.slug` (string, required)
  - `ListZones.response.200.zones.status` (string, required) — pending, active, displaced or deleting; clients treat others as unknown.
  - `ListZones.response.200.zones.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
  - `ListZones.response.200.zones.updatedAt` (string, required)
    - format `date-time`
  - `ListZones.response.200.zones.verification` (object, required)
    - `ListZones.response.200.zones.verification.lastCheckedAt` (string | null, required)
      - format `date-time`
    - `ListZones.response.200.zones.verification.txtName` (string, required)
    - `ListZones.response.200.zones.verification.txtValue` (string, required)

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.400.error` (object, required)
  - `ListZones.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.400.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.400.error.issues.message` (string, required)
    - `ListZones.response.400.error.issues.path` (string, required)
  - `ListZones.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.400.error.quota.id` (string, required)
    - `ListZones.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.400.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.400.error.quota.region` (string, optional)
    - `ListZones.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.400.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.400.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.401.error` (object, required)
  - `ListZones.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.401.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.401.error.issues.message` (string, required)
    - `ListZones.response.401.error.issues.path` (string, required)
  - `ListZones.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.401.error.quota.id` (string, required)
    - `ListZones.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.401.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.401.error.quota.region` (string, optional)
    - `ListZones.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.401.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.401.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.403.error` (object, required)
  - `ListZones.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.403.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.403.error.issues.message` (string, required)
    - `ListZones.response.403.error.issues.path` (string, required)
  - `ListZones.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.403.error.quota.id` (string, required)
    - `ListZones.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.403.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.403.error.quota.region` (string, optional)
    - `ListZones.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.403.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.403.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.404.error` (object, required)
  - `ListZones.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.404.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.404.error.issues.message` (string, required)
    - `ListZones.response.404.error.issues.path` (string, required)
  - `ListZones.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.404.error.quota.id` (string, required)
    - `ListZones.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.404.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.404.error.quota.region` (string, optional)
    - `ListZones.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.404.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.404.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.409.error` (object, required)
  - `ListZones.response.409.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.409.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.409.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.409.error.issues.message` (string, required)
    - `ListZones.response.409.error.issues.path` (string, required)
  - `ListZones.response.409.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.409.error.quota.id` (string, required)
    - `ListZones.response.409.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.409.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.409.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.409.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.409.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.409.error.quota.region` (string, optional)
    - `ListZones.response.409.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.409.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.409.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.409.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.429.error` (object, required)
  - `ListZones.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.429.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.429.error.issues.message` (string, required)
    - `ListZones.response.429.error.issues.path` (string, required)
  - `ListZones.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.429.error.quota.id` (string, required)
    - `ListZones.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.429.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.429.error.quota.region` (string, optional)
    - `ListZones.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.429.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.429.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.500.error` (object, required)
  - `ListZones.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.500.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.500.error.issues.message` (string, required)
    - `ListZones.response.500.error.issues.path` (string, required)
  - `ListZones.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.500.error.quota.id` (string, required)
    - `ListZones.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.500.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.500.error.quota.region` (string, optional)
    - `ListZones.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.500.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.500.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListZones.response.503.error` (object, required)
  - `ListZones.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListZones.response.503.error.message` (string, required)
    - maxLength 1024
  - `ListZones.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListZones.response.503.error.issues.message` (string, required)
    - `ListZones.response.503.error.issues.path` (string, required)
  - `ListZones.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListZones.response.503.error.quota.id` (string, required)
    - `ListZones.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListZones.response.503.error.quota.limit` (integer, required)
      - min 0
    - `ListZones.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListZones.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListZones.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListZones.response.503.error.quota.region` (string, optional)
    - `ListZones.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListZones.response.503.error.quota.scopeResourceName` (string, optional)
    - `ListZones.response.503.error.quota.used` (integer, optional)
      - min 0
    - `ListZones.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/dns-api/ListZones/index.md
