# Manage Domain Settings (https://developer.godaddy.com/en/docs/references/rest/domains/v2/manage-domain-settings) *** title: Manage Domain Settings description: >- Retrieve domain details and manage contacts, nameservers, forwarding rules, privacy forwarding, renewals, and redemption. full: true \_openapi: toc: * depth: 2 title: Retrieve the forwarding information for the given fqdn url: '#retrieve-the-forwarding-information-for-the-given-fqdn' * depth: 2 title: Create a new forwarding configuration for the given FQDN url: '#create-a-new-forwarding-configuration-for-the-given-fqdn' * depth: 2 title: Submit a forwarding cancellation request for the given fqdn url: '#submit-a-forwarding-cancellation-request-for-the-given-fqdn' * depth: 2 title: Modify the forwarding information for the given fqdn url: '#modify-the-forwarding-information-for-the-given-fqdn' structuredData: headings: * content: Retrieve the forwarding information for the given fqdn id: retrieve-the-forwarding-information-for-the-given-fqdn * content: Create a new forwarding configuration for the given FQDN id: create-a-new-forwarding-configuration-for-the-given-fqdn * content: Submit a forwarding cancellation request for the given fqdn id: submit-a-forwarding-cancellation-request-for-the-given-fqdn * content: Modify the forwarding information for the given fqdn id: modify-the-forwarding-information-for-the-given-fqdn contents: * content: >- Returns current change of registrant details including status, requested contacts, and any pending approvals. * content: >- Cancels a pending change of registrant. Returns 202 - poll GET .../actions/CHANGE\_OF\_REGISTRANT\_DELETE until COMPLETED, FAILED, or CANCELLED. * content: >- Replaces the domain's authoritative nameservers. Returns 202 - poll GET .../actions/DOMAIN\_UPDATE\_NAME\_SERVERS until the action reaches a terminal state. * content: >- Returns the full DomainDetailV2 object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp. * content: >- Returns the current privacy email forwarding configuration including target address and forwarding mode. * content: >- Updates privacy email forwarding settings. Only fields included in the request are modified. Returns 202 - poll the actions endpoint for completion. * content: >- Returns the forwarding configuration for the FQDN including destination URL and redirect type. Returns 404 if no forwarding rule exists. heading: retrieve-the-forwarding-information-for-the-given-fqdn * content: >- Creates or replaces the forwarding configuration for the FQDN. Idempotent - replaying the same request produces the same rule. Returns 204 No Content. heading: create-a-new-forwarding-configuration-for-the-given-fqdn * content: >- Removes the forwarding configuration for the FQDN. Returns 204 No Content. heading: submit-a-forwarding-cancellation-request-for-the-given-fqdn * content: >- Updates the forwarding configuration for the FQDN. Only fields included in the request are modified. Returns 204 No Content. heading: modify-the-forwarding-information-for-the-given-fqdn *** ## GET /v2/customers/{customerId}/domains/{domain}/changeOfRegistrant Retrieve change of registrant information Returns current change of registrant details including status, requested contacts, and any pending approvals. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `domain` | string | yes | Domain whose change of registrant information is to be retrieved | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | A client provided identifier for tracking this request. | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - object - `createDate` (required): string - `gainingContact` (required): object - `email` (required): string - `firstName` (required): string - `lastName` (required): string - `organization`: string - `losingContact` (required): object - `email` (required): string - `firstName` (required): string - `lastName` (required): string - `organization`: string - `otherDomainsAffected`: integer - `shopperEmail`: string **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, or a field that refers to an - `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, or a field that refers to an - `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** — The contact does not exist 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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — There is already a similar action processing 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, or a field that refers to an - `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** — `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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **502** — Dependent service unavailable 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, or a field that refers to an - `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`. ## DELETE /v2/customers/{customerId}/domains/{domain}/changeOfRegistrant Cancel a pending change of registrant request Cancels a pending change of registrant. Returns 202 - poll GET .../actions/CHANGE_OF_REGISTRANT_DELETE until COMPLETED, FAILED, or CANCELLED. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `domain` | string | yes | Domain whose change of registrant is to be cancelled | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | A client provided identifier for tracking this request. | ### Responses **202** — Request Accepted. You may use GET /v2/customers/{customerId}/domains/{domain}/actions/CHANGE_OF_REGISTRANT_DELETE to poll status **401** — Authentication info not sent or invalid Content-Type: `*/*` 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, or a field that refers to an - `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: `*/*` 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, or a field that refers to an - `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** — The contact does not exist Content-Type: `*/*` 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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — There is already a similar action processing Content-Type: `*/*` 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, or a field that refers to an - `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** — `domain` must be specified Content-Type: `*/*` 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, or a field that refers to an - `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: `*/*` 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, or a field that refers to an - `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: `*/*` 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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **502** — Dependent service unavailable Content-Type: `*/*` 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, or a field that refers to an - `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`. ## PUT /v2/customers/{customerId}/domains/{domain}/nameServers Replaces the existing name servers on the domain. Replaces the domain's authoritative nameservers. Returns 202 - poll GET .../actions/DOMAIN_UPDATE_NAME_SERVERS until the action reaches a terminal state. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `domain` | string | yes | Domain whose name servers are to be replaced | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | A client provided identifier for tracking this request. | ### Request body (required) Name server records to replace on the domain Content-Type: `application/json` Schema: - object - `nameServers`: array — Fully-qualified domain names for name servers to associate with the domain - items: ### Responses **202** — Request Accepted. You may use GET /v2/customers/{customerId}/domains/{domain}/actions/DOMAIN_UPDATE_NAME_SERVERS to poll status **400** — 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, or a field that refers to an - `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** — 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, or a field that refers to an - `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, or a field that refers to an - `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** — The domain does not exist 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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — There is already a similar action processing 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, or a field that refers to an - `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** — Request body doesn't fulfill schema, see details in `fields` 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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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 /v2/customers/{customerId}/domains/{domain} Retrieve details for the specified Domain Returns the full DomainDetailV2 object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `domain` | string | yes | Domain name whose details are to be retrieved | ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `includes` | array | no | Optional details to be included in the response | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | A client provided identifier for tracking this request. | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - object - `domainId` (required): string — Unique identifier for this Domain - `domain` (required): string — Name of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `status` (required): string — The current status of the domain - enum: "ACTIVE", "CANCELLED", "DELETED_REDEEMABLE", "EXPIRED", "FAILED", "LOCKED_REGISTRAR", "PARKED", "HELD_REGISTRAR", "OWNERSHIP_CHANGED", "PENDING_TRANSFER", "PENDING_REGISTRATION", "REPOSSESSED", "SUSPENDED", "TRANSFERRED" - `expiresAt`: string — Date and time when this domain will expire - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `privacy` (required): boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `transferProtected` (required): boolean — Whether or not the domain is protected from transfer - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `modifiedAt`: string — Date and time when this domain was last modified - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `authCode` (required): string — Authorization code for transferring the Domain - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `hostnames`: array — Hostnames owned by the domain - items: - `renewal`: object - `renewable`: boolean — Whether or not the domain is eligble for renewal based on status - `price` (required): integer — Price for the domain renewal excluding taxes or fees - `currency` (required): string — Currency in which the `price` is listed - `verifications`: object - `icann`: string — Status of the ICANN verification of domain registrant contact by completing email and/or phone verification - enum: "COMPLETED", "PENDING", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: string — Status of the real name verification of an identity by comparing registration data against government issued documents - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" - `domainName`: string — Status of the verification of the domain name against a prohibited list maintained by the government - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `contacts` (required): object - `registrant`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region. - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - items: - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `admin`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `tech`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `billing`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `actions`: array — List of current actions in progress for this domain - items: - `type` (required): string — The type of action being performed - enum: "AUTH_CODE_PURCHASE", "AUTH_CODE_REGENERATE", "AUTO_RENEWAL", "BACKORDER_PURCHASE", "BACKORDER_DELETE", "BACKORDER_UPDATE", "CHANGE_OF_REGISTRANT_DELETE", "CONTACT_CREATE", "CONTACT_DELETE", "CONTACT_UPDATE", "DNS_VERIFICATION", "DNSSEC_CREATE", "DNSSEC_DELETE", "DOMAIN_DELETE", "DOMAIN_UPDATE", "DOMAIN_UPDATE_CONTACTS", "DOMAIN_UPDATE_NAME_SERVERS", "EXPIRY", "HOST_CREATE", "HOST_DELETE", "ICANN_VERIFICATION", "MIGRATE", "MIGRATE_IN", "PREMIUM", "PRIVACY_PURCHASE", "PRIVACY_DELETE", "REDEEM", "REGISTER", "RENEW", "RENEW_UNDO", "TRADE", "TRADE_CANCEL", "TRADE_PURCHASE", "TRADE_PURCHASE_AUTH_TEXT_MESSAGE", "TRADE_RESEND_AUTH_EMAIL", "TRANSFER", "TRANSFER_IN", "TRANSFER_IN_ACCEPT", "TRANSFER_IN_CANCEL", "TRANSFER_IN_RESTART", "TRANSFER_IN_RETRY", "TRANSFER_OUT", "TRANSFER_OUT_ACCEPT", "TRANSFER_OUT_REJECT", "TRANSFER_OUT_REQUESTED", "TRANSIT" - `origination` (required): string — The origination of the action - enum: "USER", "SYSTEM" - `createdAt` (required): string — Timestamp indicating when the action was created - `startedAt`: string — Timestamp indicating when the action was started - `completedAt`: string — Timestamp indicating when the action was completed - `modifiedAt`: string — Timestamp indicating when the action was last modified - `status` (required): string — The current status of the action - enum: "ACCEPTED", "AWAITING", "CANCELLED", "FAILED", "PENDING", "SUCCESS" - `reason`: object - `code` (required): string — Short identifier, suitable for indicating the reason for the current status and how to handle within client code - `message`: string — Human-readable, English description of the 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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `requestId`: string — A client provided identifier (via X-Request-Id header) used for tracking individual requests - `dnssecRecords`: array — List of active DNSSEC records for this domain - items: - `algorithm` (required): string — This identifies the cryptographic algorithm used to generate the signature - enum: "RSAMD5", "DH", "DSA", "RSASHA1", "DSA_NSEC3_SHA1", "RSASHA1_NSEC3_SHA1", "RSASHA256", "RSASHA512", "ECC_GOST", "ECDSAP256SHA256", "ECDSAP384SHA384", "ED25519", "ED448", "PRIVATEDNS", "PRIVATEOID" - `keyTag`: integer — This is an integer value less than 65536 used to identify the DNSSEC record for the domain name. - `digestType`: string — This identifies the algorithm used to construct the digest - enum: "SHA1", "SHA256", "GOST", "SHA384" - `digest`: string — The digest is an alpha-numeric value - `flags`: string — This identifies the key type; either a Zone-Signing Key or a Key-Signing Key - enum: "ZSK", "KSK" - `publicKey`: string — Registries use this value to encrypt DS records. Decryption requires a matching public key - `maxSignatureLife`: integer — This specifies the validity period for the signature. The value is expressed in seconds. You can use any integer value larger than zero - `registryStatusCodes`: array — The current registry status codes of the domain - items: - enum: "ADD_PERIOD", "AUTO_RENEW_PERIOD", "CLIENT_DELETE_PROHIBITED", "CLIENT_HOLD", "CLIENT_RENEW_PROHIBITED", "CLIENT_TRANSFER_PROHIBITED", "CLIENT_UPDATE_PROHIBITED", "INACTIVE", "OK", "PENDING_CREATE", "PENDING_DELETE", "PENDING_RENEW", "PENDING_RESTORE", "PENDING_TRANSFER", "PENDING_UPDATE", "REDEMPTION_PERIOD", "RENEW_PERIOD", "SERVER_DELETE_PROHIBITED", "SERVER_HOLD", "SERVER_RENEW_PROHIBITED", "SERVER_TRANSFER_PROHIBITED", "SERVER_UPDATE_PROHIBITED", "TRANSFER_PERIOD" **203** — Request was partially successful, but actions, contacts, and/or verifications may not be included. Content-Type: `application/json` Schema: - object - `domainId` (required): string — Unique identifier for this Domain - `domain` (required): string — Name of the domain - `subaccountId`: string — Reseller subaccount shopperid who can manage the domain - `status` (required): string — The current status of the domain - enum: "ACTIVE", "CANCELLED", "DELETED_REDEEMABLE", "EXPIRED", "FAILED", "LOCKED_REGISTRAR", "PARKED", "HELD_REGISTRAR", "OWNERSHIP_CHANGED", "PENDING_TRANSFER", "PENDING_REGISTRATION", "REPOSSESSED", "SUSPENDED", "TRANSFERRED" - `expiresAt`: string — Date and time when this domain will expire - `expirationProtected` (required): boolean — Whether or not the domain is protected from expiration - `holdRegistrar` (required): boolean — Whether or not the domain is on-hold by the registrar - `locked` (required): boolean — Whether or not the domain is locked to prevent transfers - `privacy` (required): boolean — Whether or not the domain has privacy protection - `registrarCreatedAt`: string — Date and time when this domain was created by the registrar - `renewAuto` (required): boolean — Whether or not the domain is configured to automatically renew - `renewDeadline` (required): string — Date the domain must renew on - `transferProtected` (required): boolean — Whether or not the domain is protected from transfer - `createdAt` (required): string — Date and time when this domain was created - `deletedAt`: string — Date and time when this domain was deleted - `modifiedAt`: string — Date and time when this domain was last modified - `transferAwayEligibleAt`: string — Date and time when this domain is eligible to transfer - `authCode` (required): string — Authorization code for transferring the Domain - `nameServers` (required): array — Fully-qualified domain names for DNS servers - items: - `hostnames`: array — Hostnames owned by the domain - items: - `renewal`: object - `renewable`: boolean — Whether or not the domain is eligble for renewal based on status - `price` (required): integer — Price for the domain renewal excluding taxes or fees - `currency` (required): string — Currency in which the `price` is listed - `verifications`: object - `icann`: string — Status of the ICANN verification of domain registrant contact by completing email and/or phone verification - enum: "COMPLETED", "PENDING", "UNABLE_TO_RETRIEVE_STATUS" - `realName`: string — Status of the real name verification of an identity by comparing registration data against government issued documents - enum: "APPROVED", "PENDING", "REJECTED_DOCUMENT_OUTDATED", "REJECTED_EXPIRED_BUSINESS_LICENSE", "REJECTED_EXPIRED_ORGANIZATION_CODE", "REJECTED_ILLEGIBLE_DOCUMENT_NAME", "REJECTED_ILLEGIBLE_IDENTIFICATION", "REJECTED_INCOMPLETE_IDENTIFICATION", "REJECTED_INCOMPLETE_REGISTRATION_LETTER", "REJECTED_INCONSISTENT_IDENTITY_CARD", "REJECTED_INCONSISTENT_ORGANIZATION_CODE", "REJECTED_INCONSISTENT_REGISTRANT_NAME", "REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE", "REJECTED_INVALID_DOCUMENT", "REJECTED_MISMATCH_BUSINESS_ID", "REJECTED_MISMATCH_BUSINESS_NAME", "REJECTED_MISMATCH_DOCUMENT_ID", "REJECTED_MISMATCH_DOCUMENT_NAME", "REJECTED_MISMATCH_DOCUMENT_TYPE", "REJECTED_MISMATCH_REGISTRANT_INFO", "REJECTED_MISMATCH_REGISTRANT_LOCALITY", "REJECTED_MISMATCH_REGISTRANT_NAME", "REJECTED_UNABLE_TO_OPEN", "REJECTED_UNABLE_TO_VERIFY", "REJECTED_UNKNOWN_ERROR", "UNABLE_TO_RETRIEVE_STATUS" - `domainName`: string — Status of the verification of the domain name against a prohibited list maintained by the government - enum: "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" - `contacts` (required): object - `registrant`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `address1` (required): string - `address2`: string - `city` (required): string - `country` (required): string — Two-letter ISO country code to be used as a hint for target region. - enum: "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" - `postalCode` (required): string — Postal or zip code - `state` (required): string — State or province or territory - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - items: - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `admin`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `tech`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `billing`: object - `contactId`: string — Unique identifier for this Contact - `encoding`: string — The encoding of the contact data - enum: "ASCII", "UTF-8" - `nameFirst` (required): string - `nameMiddle`: string - `nameLast` (required): string - `organization`: string - `jobTitle`: string - `email` (required): string - `phone` (required): string - `fax`: string - `addressMailing` (required): object - `exposeRegistrantOrganization` (required): boolean — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` (required): boolean — Whether or not the contact details should be shown in the WHOIS - `metadata`: object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds`: array — The tlds that this contact can be assigned to - `_createdAt`: string — Timestamp indicating when the contact was created - `_modifiedAt`: string — Timestamp indicating when the contact was last modified - `_deleted`: boolean — Flag indicating if the contact has been logically deleted in the system - `_revision`: integer — The current revision number of the contact. - `actions`: array — List of current actions in progress for this domain - items: - `type` (required): string — The type of action being performed - enum: "AUTH_CODE_PURCHASE", "AUTH_CODE_REGENERATE", "AUTO_RENEWAL", "BACKORDER_PURCHASE", "BACKORDER_DELETE", "BACKORDER_UPDATE", "CHANGE_OF_REGISTRANT_DELETE", "CONTACT_CREATE", "CONTACT_DELETE", "CONTACT_UPDATE", "DNS_VERIFICATION", "DNSSEC_CREATE", "DNSSEC_DELETE", "DOMAIN_DELETE", "DOMAIN_UPDATE", "DOMAIN_UPDATE_CONTACTS", "DOMAIN_UPDATE_NAME_SERVERS", "EXPIRY", "HOST_CREATE", "HOST_DELETE", "ICANN_VERIFICATION", "MIGRATE", "MIGRATE_IN", "PREMIUM", "PRIVACY_PURCHASE", "PRIVACY_DELETE", "REDEEM", "REGISTER", "RENEW", "RENEW_UNDO", "TRADE", "TRADE_CANCEL", "TRADE_PURCHASE", "TRADE_PURCHASE_AUTH_TEXT_MESSAGE", "TRADE_RESEND_AUTH_EMAIL", "TRANSFER", "TRANSFER_IN", "TRANSFER_IN_ACCEPT", "TRANSFER_IN_CANCEL", "TRANSFER_IN_RESTART", "TRANSFER_IN_RETRY", "TRANSFER_OUT", "TRANSFER_OUT_ACCEPT", "TRANSFER_OUT_REJECT", "TRANSFER_OUT_REQUESTED", "TRANSIT" - `origination` (required): string — The origination of the action - enum: "USER", "SYSTEM" - `createdAt` (required): string — Timestamp indicating when the action was created - `startedAt`: string — Timestamp indicating when the action was started - `completedAt`: string — Timestamp indicating when the action was completed - `modifiedAt`: string — Timestamp indicating when the action was last modified - `status` (required): string — The current status of the action - enum: "ACCEPTED", "AWAITING", "CANCELLED", "FAILED", "PENDING", "SUCCESS" - `reason`: object - `code` (required): string — Short identifier, suitable for indicating the reason for the current status and how to handle within client code - `message`: string — Human-readable, English description of the 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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `requestId`: string — A client provided identifier (via X-Request-Id header) used for tracking individual requests - `dnssecRecords`: array — List of active DNSSEC records for this domain - items: - `algorithm` (required): string — This identifies the cryptographic algorithm used to generate the signature - enum: "RSAMD5", "DH", "DSA", "RSASHA1", "DSA_NSEC3_SHA1", "RSASHA1_NSEC3_SHA1", "RSASHA256", "RSASHA512", "ECC_GOST", "ECDSAP256SHA256", "ECDSAP384SHA384", "ED25519", "ED448", "PRIVATEDNS", "PRIVATEOID" - `keyTag`: integer — This is an integer value less than 65536 used to identify the DNSSEC record for the domain name. - `digestType`: string — This identifies the algorithm used to construct the digest - enum: "SHA1", "SHA256", "GOST", "SHA384" - `digest`: string — The digest is an alpha-numeric value - `flags`: string — This identifies the key type; either a Zone-Signing Key or a Key-Signing Key - enum: "ZSK", "KSK" - `publicKey`: string — Registries use this value to encrypt DS records. Decryption requires a matching public key - `maxSignatureLife`: integer — This specifies the validity period for the signature. The value is expressed in seconds. You can use any integer value larger than zero - `registryStatusCodes`: array — The current registry status codes of the domain - items: - enum: "ADD_PERIOD", "AUTO_RENEW_PERIOD", "CLIENT_DELETE_PROHIBITED", "CLIENT_HOLD", "CLIENT_RENEW_PROHIBITED", "CLIENT_TRANSFER_PROHIBITED", "CLIENT_UPDATE_PROHIBITED", "INACTIVE", "OK", "PENDING_CREATE", "PENDING_DELETE", "PENDING_RENEW", "PENDING_RESTORE", "PENDING_TRANSFER", "PENDING_UPDATE", "REDEMPTION_PERIOD", "RENEW_PERIOD", "SERVER_DELETE_PROHIBITED", "SERVER_HOLD", "SERVER_RENEW_PROHIBITED", "SERVER_TRANSFER_PROHIBITED", "SERVER_UPDATE_PROHIBITED", "TRANSFER_PERIOD" **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, or a field that refers to an - `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, or a field that refers to an - `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** — The contact does not exist 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, or a field that refers to an - `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** — `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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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 /v2/customers/{customerId}/domains/{domain}/privacy/forwarding Retrieve privacy email forwarding settings showing where emails are delivered Returns the current privacy email forwarding configuration including target address and forwarding mode. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `domain` | string | yes | Domain name whose details are to be retrieved | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | A client provided identifier for tracking this request. | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - object - `privateEmail`: string — The private email - `forwardingEmail`: string — The email that it forwards to - `emailPreference`: string — The email forwarding preference for the domain - enum: "EMAIL_FILTER", "EMAIL_SEND_ALL", "EMAIL_SEND_NONE" **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, or a field that refers to an - `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, or a field that refers to an - `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** — The domain does not exist 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, or a field that refers to an - `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** — `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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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`. ## PATCH /v2/customers/{customerId}/domains/{domain}/privacy/forwarding Update privacy email forwarding settings to determine how emails are delivered Updates privacy email forwarding settings. Only fields included in the request are modified. Returns 202 - poll the actions endpoint for completion. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `domain` | string | yes | Domain name whose details are to be retrieved | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | A client provided identifier for tracking this request. | ### Request body (required) Update privacy email forwarding settings Content-Type: `application/json` Schema: - object - `privateEmailType` (required): string — The private email type - enum: "DEFAULT", "RANDOM" - `forwardingEmail`: string — The email that it forwards to - `emailPreference` (required): string — The email forwarding preference for the domain - enum: "EMAIL_FILTER", "EMAIL_SEND_ALL", "EMAIL_SEND_NONE" ### Responses **202** — Request Accepted. You may use GET /v2/customers/{customerId}/domains/{domain}/actions/PRIVACY_FORWARDING_UPDATE to poll status **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, or a field that refers to an - `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, or a field that refers to an - `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** — The domain does not exist 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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — There is already a similar action processing 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, or a field that refers to an - `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** — Request body doesn't fulfill schema, see details in `fields` 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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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 /v2/customers/{customerId}/domains/forwards/{fqdn} Retrieve the forwarding information for the given fqdn Returns the forwarding configuration for the FQDN including destination URL and redirect type. Returns 404 if no forwarding rule exists. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `fqdn` | string | yes | The fully qualified domain name whose forwarding details are to be retrieved. | ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `includeSubs` | boolean | no | Optionally include all sub domains if the fqdn specified is a domain and not a sub domain. | ### Responses **200** — Request was successful Content-Type: `application/json` Schema: - array - items: - `fqdn` (required): string — The fqdn (domain or sub domain) to forward (ex somedomain.com or sub.somedomain.com) - `type` (required): string — The type of forwarding to implement - enum: "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" - `url` (required): string — Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/) - `mask`: object - `title`: string — Displays at the top of the browser window and in search results. - `description`: string — A short description of your website to display in search engine results. - `keywords`: string — A list of comma-separated keywords that describes the content and purpose of your website. **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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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** — A valid `fqdn` 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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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 /v2/customers/{customerId}/domains/forwards/{fqdn} Create a new forwarding configuration for the given FQDN Creates or replaces the forwarding configuration for the FQDN. Idempotent - replaying the same request produces the same rule. Returns 204 No Content. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your own customer id. | | `fqdn` | string | yes | The fully qualified domain name whose forwarding details are to be modified. | ### Request body (required) Domain forwarding rule to create for the specified fqdn Content-Type: `application/json` Schema: - object - `type` (required): string — The type of forwarding to implement - enum: "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" - `url` (required): string — Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/) - `mask`: object - `title`: string — Displays at the top of the browser window and in search results. - `description`: string — A short description of your website to display in search engine results. - `keywords`: string — A list of comma-separated keywords that describes the content and purpose of your website. ### Responses **204** — Request was successful **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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — Provided `fqdn` already has forwarding setup 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, or a field that refers to an - `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** — Request body doesn't fulfill schema, see details in `fields` 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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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`. ## DELETE /v2/customers/{customerId}/domains/forwards/{fqdn} Submit a forwarding cancellation request for the given fqdn Removes the forwarding configuration for the FQDN. Returns 204 No Content. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `fqdn` | string | yes | The fully qualified domain name whose forwarding details are to be deleted. | ### Responses **204** — Request was successful **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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — The domain status does not allow performing the operation 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, or a field that refers to an - `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** — A valid `fqdn` 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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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`. ## PUT /v2/customers/{customerId}/domains/forwards/{fqdn} Modify the forwarding information for the given fqdn Updates the forwarding configuration for the FQDN. Only fields included in the request are modified. Returns 204 No Content. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `customerId` | string | yes | The Customer identifier. Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount customer identifier you're operating on behalf of. | | `fqdn` | string | yes | The fully qualified domain name whose forwarding details are to be modified. | ### Request body (required) Domain forwarding rule to create or replace on the fqdn Content-Type: `application/json` Schema: - object - `type` (required): string — The type of forwarding to implement - enum: "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" - `url` (required): string — Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/) - `mask`: object - `title`: string — Displays at the top of the browser window and in search results. - `description`: string — A short description of your website to display in search engine results. - `keywords`: string — A list of comma-separated keywords that describes the content and purpose of your website. ### Responses **204** — Request was successful **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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `pathRelated`: string — JSONPath referring to a field containing an error, which is referenced by `path` - `message`: string — Human-readable, English description of the error **409** — The domain status does not allow performing the operation 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, or a field that refers to an - `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** — Request body doesn't fulfill schema, see details in `fields` 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, or a field that refers to an - `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, or a field that refers to an - `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, or a field that refers to an - `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`.