---
title: "Register a domain"
description: "Asynchronous: answers 202 with the operation, which charges the organization's card, registers the domain and, with EZGH DNS, delegates it to the project's zone (made now) and publishes the DS record. Refused before any charge: 409 domain_unavailable, price_changed, premium_not_supported, payment_method_required; 400 tld_not_supported, terms_not_accepted."
---

> 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: Domains API

`POST /v1/organizations/{orgId}/projects/{projectId}/domains`

Asynchronous: answers 202 with the operation, which charges the organization's card, registers the domain and, with EZGH DNS, delegates it to the project's zone (made now) and publishes the DS record. Refused before any charge: 409 domain_unavailable, price_changed, premium_not_supported, payment_method_required; 400 tld_not_supported, terms_not_accepted.

## Authentication

Requires one of the following:

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

## Path parameters

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

## Header parameters

- `RegisterDomain.header.Idempotency-Key` (string, optional) — Makes a retry safe: the same key and request get the stored response.
  - pattern `^[\x21-\x7e]{1,200}$`

## Request body

_Required._

- `RegisterDomain.acceptedTerms` (string, required) — The registration terms' version (domain-availability's terms.version).
- `RegisterDomain.domain` (string, required)
  - example `"example.com"`
- `RegisterDomain.expectedPrice` (string, required) — The price confirmed from domain-availability, USD.
  - example `"14.99"`
- `RegisterDomain.autoRenew` (boolean, optional)
  - default `true`
- `RegisterDomain.dnssec` (boolean, optional) — Default true with EZGH DNS; must be false with external nameservers.
- `RegisterDomain.nameservers` (object, optional)
  - `RegisterDomain.nameservers.mode` (string, required)
    - one of `"ezgh"`, `"external"`; default `"ezgh"`
  - `RegisterDomain.nameservers.hostnames` (array<string>, optional)
- `RegisterDomain.registrant` (one of, optional) — Omitted or null: the organization's default.
  - one of: [Contact](/domains-api/schemas/Contact/), `null`
- `RegisterDomain.years` (integer, optional)
  - min 1; max 10; default `1`

## Example request

```json
{
  "acceptedTerms": "string",
  "autoRenew": true,
  "dnssec": true,
  "domain": "example.com",
  "expectedPrice": "14.99",
  "nameservers": {
    "hostnames": [
      "string",
      "string"
    ],
    "mode": "ezgh"
  },
  "registrant": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "companyName": "string",
    "country": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "state": "string",
    "zip": "string"
  },
  "years": 1
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://domains-api.ezghcloud.com/v1/organizations/string/projects/string/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acceptedTerms": "string",
  "autoRenew": true,
  "dnssec": true,
  "domain": "example.com",
  "expectedPrice": "14.99",
  "nameservers": {
    "hostnames": [
      "string",
      "string"
    ],
    "mode": "ezgh"
  },
  "registrant": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "companyName": "string",
    "country": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "state": "string",
    "zip": "string"
  },
  "years": 1
}
'
```

### TypeScript

```typescript
const url = 'https://domains-api.ezghcloud.com/v1/organizations/string/projects/string/domains';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    acceptedTerms: 'string',
    autoRenew: true,
    dnssec: true,
    domain: 'example.com',
    expectedPrice: '14.99',
    nameservers: {hostnames: ['string', 'string'], mode: 'ezgh'},
    registrant: {
      address1: 'string',
      address2: 'string',
      city: 'string',
      companyName: 'string',
      country: 'string',
      email: 'string',
      firstName: 'string',
      lastName: 'string',
      phone: 'string',
      state: 'string',
      zip: 'string'
    },
    years: 1
  })
};

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

### Python

```python
import requests

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

payload = {
    "acceptedTerms": "string",
    "autoRenew": True,
    "dnssec": True,
    "domain": "example.com",
    "expectedPrice": "14.99",
    "nameservers": {
        "hostnames": ["string", "string"],
        "mode": "ezgh"
    },
    "registrant": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "companyName": "string",
        "country": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "state": "string",
        "zip": "string"
    },
    "years": 1
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)
```

## Responses

### 202

The operation, which Location names; poll it until it finishes.

#### Example

```json
{
  "action": "string",
  "cancellable": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "type": "user"
  },
  "error": {},
  "finishedAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "queued",
  "target": {
    "id": "string",
    "resourceName": "string",
    "type": "string"
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
```

- `RegisterDomain.response.202.action` (string, required)
- `RegisterDomain.response.202.cancellable` (boolean, required)
- `RegisterDomain.response.202.createdAt` (string, required)
  - format `date-time`
- `RegisterDomain.response.202.createdBy` (object, required)
  - `RegisterDomain.response.202.createdBy.id` (string, required)
  - `RegisterDomain.response.202.createdBy.type` (unknown, required)
    - one of `"user"`, `"bot"`
- `RegisterDomain.response.202.error` (object | null, required) — A failed operation's error, { code, message }.
- `RegisterDomain.response.202.finishedAt` (string | null, required)
  - format `date-time`
- `RegisterDomain.response.202.id` (string, required)
  - format `uuid`
- `RegisterDomain.response.202.organizationId` (string, required)
  - format `uuid`
- `RegisterDomain.response.202.projectId` (string | null, required)
  - format `uuid`
- `RegisterDomain.response.202.startedAt` (string | null, required)
  - format `date-time`
- `RegisterDomain.response.202.status` (unknown, required)
  - one of `"queued"`, `"running"`, `"succeeded"`, `"failed"`, `"cancelled"`
- `RegisterDomain.response.202.target` (object, required)
  - `RegisterDomain.response.202.target.id` (string, required)
  - `RegisterDomain.response.202.target.resourceName` (string, required)
  - `RegisterDomain.response.202.target.type` (string, required)
- `RegisterDomain.response.202.type` (string, required)
- `RegisterDomain.response.202.updatedAt` (string, required)
  - format `date-time`

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

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

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

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

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

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

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

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

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

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


Source: https://docs.ezghcloud.com/domains-api/RegisterDomain/index.md
