# Find Domains (https://developer.godaddy.com/en/docs/references/rest/domains/v1/find-domains) *** title: Find Domains full: true \_openapi: toc: * depth: 2 title: Determine whether or not the specified domain is available for purchase url: '#determine-whether-or-not-the-specified-domain-is-available-for-purchase' * depth: 2 title: >- Determine whether or not the specified domains are available for purchase url: >- \#determine-whether-or-not-the-specified-domains-are-available-for-purchase * depth: 2 title: >- Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history url: >- \#suggest-alternate-domain-names-based-on-a-seed-domain-a-set-of-keywords-or-the-shoppers-purchase-history structuredData: headings: * content: >- Determine whether or not the specified domain is available for purchase id: >- determine-whether-or-not-the-specified-domain-is-available-for-purchase * content: >- Determine whether or not the specified domains are available for purchase id: >- determine-whether-or-not-the-specified-domains-are-available-for-purchase * content: >- Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history id: >- suggest-alternate-domain-names-based-on-a-seed-domain-a-set-of-keywords-or-the-shoppers-purchase-history contents: * content: >- Checks whether a single domain is available to register and returns the current price in currency-micro-unit format. The definitive flag indicates whether the result came from a live registry query. heading: >- determine-whether-or-not-the-specified-domain-is-available-for-purchase * content: >- Checks availability for multiple domains in a single request. Returns an array of availability and pricing results, one per domain queried. heading: >- determine-whether-or-not-the-specified-domains-are-available-for-purchase * content: >- Returns domain name suggestions based on a seed domain, keywords, or purchase history. Useful for presenting alternatives when a desired domain is unavailable. heading: >- suggest-alternate-domain-names-based-on-a-seed-domain-a-set-of-keywords-or-the-shoppers-purchase-history *** ## GET /v1/domains/available Determine whether or not the specified domain is available for purchase Checks whether a single domain is available to register and returns the current price in currency-micro-unit format. The definitive flag indicates whether the result came from a live registry query. ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `domain` | string | yes | Domain name whose availability is to be checked | | `checkType` | string | no | Optimize for time ('FAST') or accuracy ('FULL') | | `forTransfer` | boolean | no | Whether or not to include domains available for transfer. If set to True, checkType is ignored | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - object - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `application/javascript` Schema: - object - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `application/xml` Schema: - object - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `text/javascript` Schema: - object - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `text/xml` Schema: - object - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — - Cannot convert domain label error - Domain is missing IDN script - Domain segment ends with dash - Domain starts with dash - Domain uses unsupported IDN script - FQDN fails generic validity regex - Invalid character(s) error - Invalid tld error - Non-IDN domain name must not have dashes at the third and fourth position - Reserved name error - domain must be specified Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## POST /v1/domains/available Determine whether or not the specified domains are available for purchase Checks availability for multiple domains in a single request. Returns an array of availability and pricing results, one per domain queried. ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `checkType` | string | no | Optimize for time ('FAST') or accuracy ('FULL') | ### Request body (required) Domain names for which to check availability Content-Type: `application/json` Schema: - array - items: Content-Type: `application/xml` Schema: - array - items: Content-Type: `text/xml` Schema: - array - items: ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `application/javascript` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `application/xml` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `text/javascript` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered Content-Type: `text/xml` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered **203** — Request was partially successful Content-Type: `application/json` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered - `errors`: array — Errors encountered while performing a domain available check - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domain` (required): string — Domain name - `message`: string — Human-readable, English description of the error - `path` (required): string — - JSONPath referring to a field containing an error - `status` (required): integer — HTTP status code that would return for a single check Content-Type: `application/javascript` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered - `errors`: array — Errors encountered while performing a domain available check - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domain` (required): string — Domain name - `message`: string — Human-readable, English description of the error - `path` (required): string — - JSONPath referring to a field containing an error - `status` (required): integer — HTTP status code that would return for a single check Content-Type: `application/xml` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered - `errors`: array — Errors encountered while performing a domain available check - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domain` (required): string — Domain name - `message`: string — Human-readable, English description of the error - `path` (required): string — - JSONPath referring to a field containing an error - `status` (required): integer — HTTP status code that would return for a single check Content-Type: `text/javascript` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered - `errors`: array — Errors encountered while performing a domain available check - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domain` (required): string — Domain name - `message`: string — Human-readable, English description of the error - `path` (required): string — - JSONPath referring to a field containing an error - `status` (required): integer — HTTP status code that would return for a single check Content-Type: `text/xml` Schema: - object - `domains` (required): array — Domain available response array - items: - `available` (required): boolean — Whether or not the domain name is available - `currency`: string — Currency in which the `price` is listed. Only returned if tld is offered - `definitive` (required): boolean — Whether or not the `available` answer has been definitively verified with the registry - `domain` (required): string — Domain name - `period`: integer — Number of years included in the price. Only returned if tld is offered - `price`: integer — Price of the domain excluding taxes or fees. Only returned if tld is offered - `errors`: array — Errors encountered while performing a domain available check - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `domain` (required): string — Domain name - `message`: string — Human-readable, English description of the error - `path` (required): string — - JSONPath referring to a field containing an error - `status` (required): integer — HTTP status code that would return for a single check **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — - Cannot convert domain label error - Domain is missing IDN script - Domain segment ends with dash - Domain starts with dash - Domain uses unsupported IDN script - FQDN fails generic validity regex - Invalid character(s) error - Invalid tld error - Non-IDN domain name must not have dashes at the third and fourth position - Reserved name error - domain must be specified Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`. ## GET /v1/domains/suggest Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history Returns domain name suggestions based on a seed domain, keywords, or purchase history. Useful for presenting alternatives when a desired domain is unavailable. ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `query` | string | no | Domain name or set of keywords for which alternative domain names will be suggested | | `country` | string | no | Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more | | `city` | string | no | Name of city to be used as a hint for target region | | `sources` | array | no | Sources to be queried - **CC_TLD** — Varies the TLD using Country Codes - **EXTENSION** — Varies the TLD - **KEYWORD_SPIN** — Identifies keywords and then rotates each one - **PREMIUM** — Includes variations with premium prices | | `tlds` | array | no | Top-level domains to be included in suggestions NOTE: These are sample values, there are many more | | `lengthMax` | integer | no | Maximum length of second-level domain | | `lengthMin` | integer | no | Minimum length of second-level domain | | `limit` | integer | no | Maximum number of suggestions to return | | `waitMs` | integer | no | Maximum amount of time, in milliseconds, to wait for responses If elapses, return the results compiled up to that point | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Shopper-Id` | string | no | Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - array - items: - `domain` (required): string — Suggested domain name Content-Type: `application/javascript` Schema: - array - items: - `domain` (required): string — Suggested domain name Content-Type: `application/xml` Schema: - array - items: - `domain` (required): string — Suggested domain name Content-Type: `text/javascript` Schema: - array - items: - `domain` (required): string — Suggested domain name Content-Type: `text/xml` Schema: - array - items: - `domain` (required): string — Suggested domain name **400** — Request was malformed Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **401** — Authentication info not sent or invalid Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **403** — Authenticated user is not allowed access Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **404** — Resource not found Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **422** — `query` must be specified Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **429** — Too many requests received within interval Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error - `retryAfterSec` (required): integer — Number of seconds to wait before attempting a similar request **500** — Internal server error Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **504** — Gateway timeout Content-Type: `application/json` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `application/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/javascript` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error Content-Type: `text/xml` Schema: - object - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `fields`: array — List of the specific fields, and the errors found with their contents - items: - `code` (required): string — Short identifier for the error, suitable for indicating the specific error within client code - `message`: string — Human-readable, English description of the problem with the contents of the field - `path` (required): string — - JSONPath referring to a field containing an error - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **Security:** requires `bearerAuth`.