---
title: "Look up a domain's existing records into a proposal"
description: "Writes nothing: asks the nameservers the domain's parent delegates it to for a fixed list of common names and types, and answers what it found, to review and apply through records/changes. DNS can't list a zone, so names outside that list aren't found. Takes about 8 seconds at most, and answers what it found by then, with one note in skipped whose type is empty when it couldn't ask everything. A domain that isn't delegated, or that's delegated to EZGH DNS, gives an empty proposal. Takes no body. Refused with 409 zone_deleting once the zone is being deleted. Takes no Idempotency-Key: it keeps nothing, so a retry runs again."
---

> 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

`POST /v1/organizations/{orgId}/projects/{projectId}/zones/{zoneId}/records/scan`

Writes nothing: asks the nameservers the domain's parent delegates it to for a fixed list of common names and types, and answers what it found, to review and apply through records/changes. DNS can't list a zone, so names outside that list aren't found. Takes about 8 seconds at most, and answers what it found by then, with one note in skipped whose type is empty when it couldn't ask everything. A domain that isn't delegated, or that's delegated to EZGH DNS, gives an empty proposal. Takes no body. Refused with 409 zone_deleting once the zone is being deleted. Takes no Idempotency-Key: it keeps nothing, so a retry runs again.

## Authentication

Requires one of the following:

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

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

A proposal. Nothing has been written: apply it through records/changes.

#### Example

```json
{
  "adjusted": [
    {
      "name": "string",
      "reason": "string",
      "type": "string"
    }
  ],
  "recordSets": [
    {
      "managedBy": {
        "resourceName": "string",
        "service": "string"
      },
      "name": "string",
      "ttl": 60,
      "type": "A",
      "values": [
        "string"
      ]
    }
  ],
  "skipped": [
    {
      "name": "string",
      "reason": "string",
      "type": "string"
    }
  ]
}
```

- `ScanRecordSets.response.200.adjusted` (array<object>, required) — What was changed to fit, and how.
  - `ScanRecordSets.response.200.adjusted.name` (string, required) — Relative to the zone, or absolute for a name outside it.
  - `ScanRecordSets.response.200.adjusted.reason` (string, required)
  - `ScanRecordSets.response.200.adjusted.type` (string, required) — The record type; empty on a note about the whole scan.
- `ScanRecordSets.response.200.recordSets` (array<object>, required) — Valid together, so applying them as upserts is refused only for how they meet what's already in the zone.
  - `ScanRecordSets.response.200.recordSets.managedBy` (object | null, required) — The service that manages this set for one of its resources, or null for your own. A managed set can't be changed through records/changes, and its zone can't be deleted, until that service lets it go.
    - `ScanRecordSets.response.200.recordSets.managedBy.resourceName` (string, required)
    - `ScanRecordSets.response.200.recordSets.managedBy.service` (string, required) — certificates: Web Certificates, for a domain authorization.
  - `ScanRecordSets.response.200.recordSets.name` (string, required) — Relative to the zone; @ is the zone itself.
  - `ScanRecordSets.response.200.recordSets.ttl` (integer, required)
    - min 60; max 86400
  - `ScanRecordSets.response.200.recordSets.type` (unknown, required)
    - one of `"A"`, `"AAAA"`, `"CNAME"`, `"MX"`, `"TXT"`, `"NS"`, `"SRV"`, `"CAA"`, `"PTR"`, `"DS"`
  - `ScanRecordSets.response.200.recordSets.values` (array<string>, required) — TXT values are plain text, without surrounding quotes; a long one needs no splitting.
- `ScanRecordSets.response.200.skipped` (array<object>, required) — What was left out, and why.
  - `ScanRecordSets.response.200.skipped.name` (string, required) — Relative to the zone, or absolute for a name outside it.
  - `ScanRecordSets.response.200.skipped.reason` (string, required)
  - `ScanRecordSets.response.200.skipped.type` (string, required) — The record type; empty on a note about the whole scan.

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

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

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

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

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

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

### 413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

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

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

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

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

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


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