## GET /api/v2/dns-zones

**List DNS zones**

Return DNS zones available to the account. Use `name=example.com` to find the public `zone_...` ID when the caller only knows the DNS zone/domain name. Use each `data[].id` as the `id` path parameter on `GET /api/v2/dns-zones/{id}` to list records for that zone. This endpoint does not return authoritative domain nameservers; use `GET /api/v2/domains/{id}/nameservers` for that.

### Related Endpoints

- `GET /api/v2/dns-zones/{id}`: Get DNS zone and records
- `POST /api/v2/dns-zones/{id}/records`: Create DNS record
- `PUT /api/v2/dns-zones/{id}/records/{recordId}`: Update DNS record

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scopes: `read:dns`, `read:domains`

### Parameters

- `limit` (query, integer) [min: 1, max: 1000]: Maximum DNS zones to return in this page.
- `cursor` (query, string): Opaque cursor from `nextCursor` for the next page.
- `name` (query, string): Exact DNS zone name to find, for example `example.com`. Use this to get the public `zone_...` ID before listing records. Example: `example.com`

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/dns-zones" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `data` (array<object>, optional)
- `data[].id` (string, required) Example: `zone_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `data[].name` (string, required) Example: `example.com`
- `data[].zoneStatus` (string, required) Example: `active`
  Allowed values: active, disabled, pending, error, unknown
- `data[].isDnsOnly` (boolean, required) Example: `false`
- `data[].kind` (string, required) Example: `linked`
  Allowed values: dns_only, linked
- `data[].recordCount` (integer, optional) Example: `12`
- `hasMore` (boolean, optional) Example: `false`
- `nextCursor` (string,null, optional) Example: `null`

### Responses

#### 200 - Cursor-paginated list.
```json
{
  "data": [
    {
      "id": "zone_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "example.com",
      "zoneStatus": "active",
      "isDnsOnly": false,
      "kind": "linked"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```