---
title: "Get a zone"
---

> 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/{zoneId}`

## Authentication

Requires one of the following:

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

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://dns-api.ezghcloud.com/v1/organizations/string/projects/string/zones/string';
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/string"

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

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

print(response.text)
```

## Responses

### 200

The zone.

#### Example

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

- `GetZone.response.200.createdAt` (string, required)
  - format `date-time`
- `GetZone.response.200.dnssec` (object, required)
  - `GetZone.response.200.dnssec.dsRecords` (array<string>, required)
  - `GetZone.response.200.dnssec.enabled` (boolean, required)
- `GetZone.response.200.domain` (string, required)
- `GetZone.response.200.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.
- `GetZone.response.200.id` (string, required)
  - format `uuid`
- `GetZone.response.200.name` (string, required) — The zone's domain.
- `GetZone.response.200.nameservers` (array<string>, required) — This zone's two nameservers.
- `GetZone.response.200.organizationId` (string, required)
  - format `uuid`
- `GetZone.response.200.projectId` (string | null, required)
  - format `uuid`
- `GetZone.response.200.recordSetCount` (integer, required)
- `GetZone.response.200.region` (string, required) — Empty: zones aren't regional.
- `GetZone.response.200.resourceName` (string, required)
- `GetZone.response.200.slug` (string, required)
- `GetZone.response.200.status` (string, required) — pending, active, displaced or deleting; clients treat others as unknown.
- `GetZone.response.200.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
- `GetZone.response.200.updatedAt` (string, required)
  - format `date-time`
- `GetZone.response.200.verification` (object, required)
  - `GetZone.response.200.verification.lastCheckedAt` (string | null, required)
    - format `date-time`
  - `GetZone.response.200.verification.txtName` (string, required)
  - `GetZone.response.200.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"
    }
  }
}
```

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

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

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

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

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

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

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

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


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