Query structured spec data via REST or MCP. Get exactly what your agent needs.
//api.ote-godaddy.com
/v1/domains/{domain}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| domain | path | required | string | Domain whose details are to be updated |
| X-Shopper-Id | header | optional | string | Shopper for whom Domain is to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you’re a Reseller, but purchased a Domain via http://www.godaddy.com |
Changes to apply to existing Domain
text/xml
DomainUpdate
application/xml
DomainUpdate
application/json
DomainUpdate
Request was successful
Request was malformed
Authentication info not sent or invalid
Specified Subaccount not owned by authenticated Shopper
Resource not found
The given domain is not eligible to have its nameservers changed
At least two apex (aka @) nameServers must be specified
Failed to update nameservers
Too many requests received within interval
Internal server error
PATCH /v1/domains/{domain}
/v1/domains/{domain}/contacts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| X-Shopper-Id | header | optional | string | Shopper for whom domain contacts are to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you’re a Reseller, but purchased a Domain via http://www.godaddy.com |
| domain | path | required | string | Domain whose Contacts are to be updated. |
Changes to apply to existing Contacts
text/xml
DomainContacts
application/xml
DomainContacts
application/json
DomainContacts
No response was specified
Request was successful
Request was malformed
Authentication info not sent or invalid
Authenticated user is not allowed access
Domain not found
Identity document not found
domain is not a valid Domain name
Too many requests received within interval
Internal server error
Gateway timeout
PATCH /v1/domains/{domain}/contacts
/v1/domains/{domain}/records
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| X-Shopper-Id | header | optional | string | Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you’re a Reseller, but purchased a Domain via http://www.godaddy.com |
| domain | path | required | string | Domain whose DNS Records are to be augmented |
DNS Records to add to whatever currently exists
text/xml
ArrayOfDNSRecord
application/xml
ArrayOfDNSRecord
application/json
ArrayOfDNSRecord
Request was successful
Request was malformed
Authentication info not sent or invalid
Authenticated user is not allowed access
Resource not found
domain is not a valid Domain name
Too many requests received within interval
Internal server error
Gateway timeout
PATCH /v1/domains/{domain}/records
Action
{
"required": [
"type",
"origination",
"createdAt",
"status"
],
"properties": {
"type": {
"enum": [
"AUTH_CODE_PURCHASE",
"AUTH_CODE_REGENERATE",
"AUTO_RENEWAL",
"BACKORDER_PURCHASE",
"BACKORDER_DELETE",
"BACKORDER_UPDATE",
"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"
],
"type": "string",
"description": "The type of action being performed<br/><ul><li><strong style='margin-left: 12px;'>AUTH_CODE_PURCHASE</strong> - Request for an auth code for a .de domain via POST /v2/customers/{customerId}/domains/{domain}/purchaseAuthCode.</li><li><strong style='margin-left: 12px;'>AUTH_CODE_REGENERATE</strong> - Request to regenerate the authCode for a domain via POST /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode</li><li><strong style='margin-left: 12px;'>AUTO_RENEWAL</strong> - A Domain Auto Renew is in progress.</li><li><strong style='margin-left: 12px;'>BACKORDER_PURCHASE</strong> - Request to purchase a domain backorder via POST /v2/customers/{customerId}/domains/backorders/purchase.</li><li><strong style='margin-left: 12px;'>BACKORDER_DELETE</strong> - Request to cancel the current domain backorder via DELETE /v2/customers/{customerId}/domains/backorders/{domain}.</li><li><strong style='margin-left: 12px;'>BACKORDER_UPDATE</strong> - Request update the current domain backorder via PATCH /v2/customers/{customerId}/domains/backorders/{domain}.</li><li><strong style='margin-left: 12px;'>CONTACT_CREATE</strong> - Request to create a contact via POST /v2/customers/{customerId}/domains/contacts.</li><li><strong style='margin-left: 12px;'>CONTACT_DELETE</strong> - Request to delete a contact via DELETE /v2/customers/{customerId}/domains/contacts/{contactId}</li><li><strong style='margin-left: 12px;'>CONTACT_UPDATE</strong> - Request to update a contact via PATCH /v2/customers/{customerId}/domains/contacts/{contactId}</li><li><strong style='margin-left: 12px;'>DNS_VERIFICATION</strong> - Domain requires zone file setup.</li><li><strong style='margin-left: 12px;'>DNSSEC_CREATE</strong> - Request to create DNSSEC record for the domain via PATCH /v2/customers/{customerId}/domains/{domain}/dnssecRecords.</li><li><strong style='margin-left: 12px;'>DNSSEC_DELETE</strong> - Request to delete DNSSEC record for the domain via DELETE /v2/customers/{customerId}/domains/{domain}/dnssecRecords.</li><li><strong style='margin-left: 12px;'>DOMAIN_DELETE</strong> - Request to delete the domain via DELETE /v2/customers/{customerId}/domains/{domain}</li><li><strong style='margin-left: 12px;'>DOMAIN_UPDATE</strong> - Request to update the domain via PATCH /v2/customers/{customerId}/domains/{domain}</li><li><strong style='margin-left: 12px;'>DOMAIN_UPDATE_CONTACTS</strong> -Request to update the domain contacts via PATCH /v2/customers/{customerId}/domains/{domain}/contacts</li><li><strong style='margin-left: 12px;'>DOMAIN_UPDATE_NAME_SERVERS</strong> - Request to update the domain name servers via PUT /v2/customers/{customerId}/domains/{domain}/nameServers</li><li><strong style='margin-left: 12px;'>EXPIRY</strong> - A Domain Expiration is in progress.</li><li><strong style='margin-left: 12px;'>HOST_CREATE</strong> - Request to create a hostname via PUT /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}</li><li><strong style='margin-left: 12px;'>HOST_DELETE</strong> - Request to delete a hostname via DELETE /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}</li><li><strong style='margin-left: 12px;'>ICANN_VERIFICATION</strong> - Domain requires registrant verification for Icann.</li><li><strong style='margin-left: 12px;'>PREMIUM</strong> - Premium Domain domain sale is in progress.</li><li><strong style='margin-left: 12px;'>PRIVACY_PURCHASE</strong> - Request to purchase privacy for a domain via POST /v2/customers/{customerId}/domains/{domain}/privacy/purchase</li><li><strong style='margin-left: 12px;'>PRIVACY_DELETE</strong> - Request to remove privacy from a domain via DELETE /v2/customers/{customerId}/domains/{domain}/privacy</li><li><strong style='margin-left: 12px;'>REDEEM</strong> - Request to redeem a domain via POST /v2/customers/{customerId}/domains/{domain}/redeem</li><li><strong style='margin-left: 12px;'>REGISTER</strong> - Request to register a domain via POST /v2/customers/{customerId}/domains/{domain}/register</li><li><strong style='margin-left: 12px;'>RENEW</strong> - Request to renew a domain via POST /v2/customers/{customerId}/domains/{domain}/renew</li><li><strong style='margin-left: 12px;'>RENEW_UNDO</strong> - Request to undo a renewal for a uk domain via POST /v2/customers/{customerId}/domains/{domain}/undoRenew</li><li><strong style='margin-left: 12px;'>TRADE</strong> - A domain trade request is in progress</li><li><strong style='margin-left: 12px;'>TRADE_CANCEL</strong> - Request to cancel a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeCancel</li><li><strong style='margin-left: 12px;'>TRADE_PURCHASE</strong> - Request to purchase a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchase</li><li><strong style='margin-left: 12px;'>TRADE_PURCHASE_AUTH_TEXT_MESSAGE</strong> - Request for a trade purchase text message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchaseAuthorizationTextMessage</li><li><strong style='margin-left: 12px;'>TRADE_RESEND_AUTH_EMAIL</strong> - Request to resend the trade auth email message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeResendAuthorizationEmail</li><li><strong style='margin-left: 12px;'>TRANSFER</strong> - Request to transfer a domain via POST /v2/customers/{customerId}/domains/{domain}/transfer</li><li><strong style='margin-left: 12px;'>TRANSFER_IN</strong> - A domain transfer in request is in progress.</li><li><strong style='margin-left: 12px;'>TRANSFER_IN_ACCEPT</strong> - Request to accept a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInAccept</li><li><strong style='margin-left: 12px;'>TRANSFER_IN_CANCEL</strong> - Request to cancel a domain transfer via POST /v2/customers/{customerId}/domains/{domain}/transferInCancel</li><li><strong style='margin-left: 12px;'>TRANSFER_IN_RESTART</strong> - Request to restart a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRestart</li><li><strong style='margin-left: 12px;'>TRANSFER_IN_RETRY</strong> - Request to retry a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRetry</li><li><strong style='margin-left: 12px;'>TRANSFER_OUT</strong> - A domain transfer out request is in progress.</li><li><strong style='margin-left: 12px;'>TRANSFER_OUT_ACCEPT</strong> - Request to accept a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutAccept</li><li><strong style='margin-left: 12px;'>TRANSFER_OUT_REJECT</strong> - Request to reject a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutReject</li><li><strong style='margin-left: 12px;'>TRANSFER_OUT_REQUESTED</strong> - Request to transfer out for a domain (.de) via POST /v2/customers/{customerId}/domains/{domain}/transferOut</li><li><strong style='margin-left: 12px;'>TRANSIT</strong> - Request to transit a de or at domain at the registry via POST /v2/customers/{customerId}/domains/{domain}/transit</li></ul>"
},
"reason": {
"$ref": "#/components/schemas/ActionReason"
},
"status": {
"enum": [
"ACCEPTED",
"AWAITING",
"CANCELLED",
"FAILED",
"PENDING",
"SUCCESS"
],
"type": "string",
"default": "ACCEPTED",
"description": "The current status of the action<br/><ul><li><strong style='margin-left: 12px;'>ACCEPTED</strong> - The action has been queued, processing has not started.</li><li><strong style='margin-left: 12px;'>AWAITING</strong> - The action is waiting on a user input.</li><li><strong style='margin-left: 12px;'>CANCELLED</strong> - The action has been cancelled by the user.</li><li><strong style='margin-left: 12px;'>FAILED</strong> - An error occurred while the action was processing, no more processing will be performed.</li><li><strong style='margin-left: 12px;'>PENDING</strong> - The action is being processed.</li><li><strong style='margin-left: 12px;'>SUCCESS</strong> - The action has completed, no additional processing is required.</li></ul>"
},
"createdAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the action was created"
},
"requestId": {
"type": "string",
"description": "A client provided identifier (via X-Request-Id header) used for tracking individual requests"
},
"startedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the action was started"
},
"modifiedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the action was last modified"
},
"completedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the action was completed"
},
"origination": {
"enum": [
"USER",
"SYSTEM"
],
"type": "string",
"description": "The origination of the action<br/><ul><li><strong style='margin-left: 12px;'>USER</strong> - These are user requests.</li><li><strong style='margin-left: 12px;'>SYSTEM</strong> - These are system processing actions.</li></ul>"
}
}
}
ActionReason
{
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"format": "constant",
"pattern": "^[A-Z_][A-Z0-9_]*$",
"description": "Short identifier, suitable for indicating the reason for the current status and how to handle within client code"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorField"
},
"description": "List of the specific fields, and the errors found with their contents"
},
"message": {
"type": "string",
"description": "Human-readable, English description of the code"
}
},
"additionalProperties": false
}
ActionsGetRecentListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Action"
}
}
Address
{
"required": [
"address1",
"city",
"state",
"postalCode",
"country"
],
"properties": {
"city": {
"type": "string",
"format": "city-name"
},
"state": {
"type": "string",
"format": "state-province-territory",
"description": "State or province or territory"
},
"country": {
"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"
],
"type": "string",
"format": "iso-country-code",
"default": "US",
"description": "Two-letter ISO country code to be used as a hint for target region<br/><br/>\nNOTE: These are sample values, there are many\n<a href='http://www.iso.org/iso/country_codes.htm'>more</a>"
},
"address1": {
"type": "string",
"format": "street-address"
},
"address2": {
"type": "string",
"format": "street-address2"
},
"postalCode": {
"type": "string",
"format": "postal-code",
"description": "Postal or zip code"
}
}
}
ArrayOfDNSRecord
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DNSRecord"
}
}
Consent
{
"required": [
"agreementKeys",
"agreedBy",
"agreedAt"
],
"properties": {
"agreedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the end-user consented to these legal agreements"
},
"agreedBy": {
"type": "string",
"description": "Originating client IP address of the end-user's computer when they consented to these legal agreements"
},
"agreementKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Unique identifiers of the legal agreements to which the end-user has agreed, as returned from the/domains/agreements endpoint"
}
}
}
ConsentDomainUpdate
{
"required": [
"agreementKeys",
"agreedBy",
"agreedAt"
],
"properties": {
"agreedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the end-user consented to these agreements"
},
"agreedBy": {
"type": "string",
"description": "Originating client IP address of the end-user's computer when they consented to the agreements"
},
"agreementKeys": {
"type": "array",
"items": {
"enum": [
"EXPOSE_WHOIS"
],
"type": "string"
},
"description": "Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated<br/><ul><li><strong style='margin-left: 12px;'>EXPOSE_WHOIS</strong> - Required when the exposeWhois field is updated to true</li></ul>"
}
}
}
ConsentRedemption
{
"required": [
"price",
"fee",
"currency",
"agreedBy",
"agreedAt"
],
"properties": {
"fee": {
"type": "integer",
"format": "currency-micro-unit",
"description": "Fee charged for the domain redemption. Please use GET /v2/customers/{customerId}/domains/{domain} to retrieve the redemption fee and currency for the domain"
},
"price": {
"type": "integer",
"format": "currency-micro-unit",
"description": "Price for the domain renewal (if domain renewal required for redemption). Please use GET /v2/customers/{customerId}/domains/{domain} to retrieve the redemption price and currency for the domain"
},
"agreedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the end-user consented to these legal agreements"
},
"agreedBy": {
"type": "string",
"description": "Originating client IP address of the end-user's computer when they consented to these legal agreements"
},
"currency": {
"type": "string",
"format": "iso-currency-code",
"default": "USD",
"pattern": "^[A-Z][A-Z][A-Z]$",
"description": "Currency in which the `price` and `fee` are listed"
}
},
"additionalProperties": false
}
ConsentRenew
{
"required": [
"price",
"currency",
"agreedBy",
"agreedAt"
],
"properties": {
"price": {
"type": "integer",
"format": "currency-micro-unit",
"description": "Price of the domain excluding taxes or fees. Please use GET /v2/customers/{customerId}/domains/{domain} to retrieve the renewal price and currency for the domain"
},
"agreedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the end-user consented to these legal agreements"
},
"agreedBy": {
"type": "string",
"description": "Originating client IP address of the end-user's computer when they consented to these legal agreements"
},
"currency": {
"type": "string",
"format": "iso-currency-code",
"default": "USD",
"pattern": "^[A-Z][A-Z][A-Z]$",
"description": "Currency in which the `price` is listed"
},
"registryPremiumPricing": {
"type": "boolean",
"description": "Only required for hosted registrar if domain is premium. If true indicates that the `price` and `currency` listed are the registry premium price and currency for the domain"
}
},
"additionalProperties": false
}
ConsentV2
{
"required": [
"agreementKeys",
"price",
"currency",
"agreedBy",
"agreedAt"
],
"properties": {
"price": {
"type": "integer",
"format": "currency-micro-unit",
"description": "Price of the domain excluding taxes or fees. Please use GET /v1/domains/available to retrieve the price and currency for the domain"
},
"agreedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the end-user consented to these legal agreements"
},
"agreedBy": {
"type": "string",
"description": "Originating client IP address of the end-user's computer when they consented to these legal agreements"
},
"currency": {
"type": "string",
"format": "iso-currency-code",
"default": "USD",
"pattern": "^[A-Z][A-Z][A-Z]$",
"description": "Currency in which the `price` is listed"
},
"claimToken": {
"type": "string",
"description": "The trademark claim token, only needed if the domain has an active trademark claim"
},
"agreementKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Unique identifiers of the legal agreements to which the end-user has agreed, as returned from the/domains/agreements endpoint"
},
"registryPremiumPricing": {
"type": "boolean",
"description": "Only required for hosted registrar if domain is premium. If true indicates that the `price` and `currency` listed are the registry premium price and currency for the domain"
}
},
"additionalProperties": false
}
Contact
{
"required": [
"nameFirst",
"nameLast",
"email",
"phone",
"addressMailing"
],
"properties": {
"fax": {
"type": "string",
"format": "phone"
},
"email": {
"type": "string",
"format": "email"
},
"phone": {
"type": "string",
"format": "phone"
},
"jobTitle": {
"type": "string"
},
"nameLast": {
"type": "string",
"format": "person-name"
},
"nameFirst": {
"type": "string",
"format": "person-name"
},
"nameMiddle": {
"type": "string"
},
"organization": {
"type": "string",
"format": "organization-name"
},
"addressMailing": {
"$ref": "#/components/schemas/Address"
}
}
}
ContactDomain
{
"required": [
"nameFirst",
"nameLast",
"email",
"phone",
"addressMailing",
"exposeWhois"
],
"properties": {
"fax": {
"type": "string",
"format": "phone",
"maxLength": 17
},
"tlds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tlds that this contact can be assigned to"
},
"email": {
"type": "string",
"format": "email",
"maxLength": 80
},
"phone": {
"type": "string",
"format": "phone",
"maxLength": 17
},
"_deleted": {
"type": "boolean",
"description": "Flag indicating if the contact has been logically deleted in the system"
},
"encoding": {
"enum": [
"ASCII",
"UTF-8"
],
"type": "string",
"default": "ASCII",
"description": "The encoding of the contact data<br/><ul><li><strong style='margin-left: 12px;'>ASCII</strong> - Data contains only ASCII characters that are not region or language specific</li><li><strong style='margin-left: 12px;'>UTF-8</strong> - Data contains characters that are specific to a region or language</li></ul>"
},
"jobTitle": {
"type": "string"
},
"metadata": {
"type": "object",
"description": "The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld}"
},
"nameLast": {
"type": "string",
"format": "person-name",
"maxLength": 30
},
"_revision": {
"type": "integer",
"description": "The current revision number of the contact."
},
"contactId": {
"type": "string",
"description": "Unique identifier for this Contact"
},
"nameFirst": {
"type": "string",
"format": "person-name",
"maxLength": 30
},
"_createdAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the contact was created"
},
"nameMiddle": {
"type": "string"
},
"_modifiedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Timestamp indicating when the contact was last modified"
},
"exposeWhois": {
"type": "boolean",
"description": "Whether or not the contact details should be shown in the WHOIS"
},
"organization": {
"type": "string",
"format": "organization-name",
"maxLength": 100
},
"addressMailing": {
"$ref": "#/components/schemas/Address"
}
}
}
ContactDomainCreate
{
"required": [
"encoding",
"nameFirst",
"nameLast",
"email",
"phone",
"addressMailing"
],
"properties": {
"fax": {
"type": "string",
"format": "phone",
"maxLength": 17
},
"email": {
"type": "string",
"format": "email",
"maxLength": 80
},
"phone": {
"type": "string",
"format": "phone",
"maxLength": 17
},
"encoding": {
"enum": [
"ASCII",
"UTF-8"
],
"type": "string",
"default": "ASCII",
"description": "The encoding of the contact data<br/><ul><li><strong style='margin-left: 12px;'>ASCII</strong> - Data contains only ASCII characters that are not region or language specific</li><li><strong style='margin-left: 12px;'>UTF-8</strong> - Data contains characters that are specific to a region or language</li></ul>"
},
"jobTitle": {
"type": "string"
},
"metadata": {
"type": "object",
"description": "The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld}"
},
"nameLast": {
"type": "string",
"format": "person-name",
"maxLength": 30
},
"nameFirst": {
"type": "string",
"format": "person-name",
"maxLength": 30
},
"nameMiddle": {
"type": "string"
},
"organization": {
"type": "string",
"format": "organization-name",
"maxLength": 100
},
"addressMailing": {
"$ref": "#/components/schemas/Address"
}
},
"additionalProperties": false
}
DNSRecord
{
"required": [
"type",
"name",
"data"
],
"properties": {
"ttl": {
"type": "integer",
"format": "integer-positive"
},
"data": {
"type": "string"
},
"name": {
"type": "string",
"format": "domain"
},
"port": {
"type": "integer",
"maximum": 65535,
"minimum": 1,
"description": "Service port (SRV only)"
},
"type": {
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"NS",
"SOA",
"SRV",
"TXT"
],
"type": "string"
},
"weight": {
"type": "integer",
"format": "integer-positive",
"description": "Record weight (SRV only)"
},
"service": {
"type": "string",
"description": "Service type (SRV only)"
},
"priority": {
"type": "integer",
"format": "integer-positive",
"description": "Record priority (MX and SRV only)"
},
"protocol": {
"type": "string",
"description": "Service protocol (SRV only)"
}
}
}
DNSRecordCreateType
{
"required": [
"name",
"data"
],
"properties": {
"ttl": {
"type": "integer",
"format": "integer-positive"
},
"data": {
"type": "string"
},
"name": {
"type": "string",
"format": "domain"
},
"port": {
"type": "integer",
"maximum": 65535,
"minimum": 1,
"description": "Service port (SRV only)"
},
"weight": {
"type": "integer",
"format": "integer-positive",
"description": "Record weight (SRV only)"
},
"service": {
"type": "string",
"description": "Service type (SRV only)"
},
"priority": {
"type": "integer",
"format": "integer-positive",
"description": "Record priority (MX and SRV only)"
},
"protocol": {
"type": "string",
"description": "Service protocol (SRV only)"
}
}
}
DNSRecordCreateTypeName
{
"required": [
"data"
],
"properties": {
"ttl": {
"type": "integer",
"format": "integer-positive"
},
"data": {
"type": "string"
},
"port": {
"type": "integer",
"maximum": 65535,
"minimum": 1,
"description": "Service port (SRV only)"
},
"weight": {
"type": "integer",
"format": "integer-positive",
"description": "Record weight (SRV only)"
},
"service": {
"type": "string",
"description": "Service type (SRV only)"
},
"priority": {
"type": "integer",
"format": "integer-positive",
"description": "Record priority (MX and SRV only)"
},
"protocol": {
"type": "string",
"description": "Service protocol (SRV only)"
}
}
}
DomainAvailableBulk
{
"required": [
"domains"
],
"properties": {
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainAvailableResponse"
},
"description": "Domain available response array"
}
}
}
DomainAvailableBulkMixed
{
"required": [
"domains"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainAvailableError"
},
"description": "Errors encountered while performing a domain available check"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainAvailableResponse"
},
"description": "Domain available response array"
}
}
}
DomainAvailableError
{
"required": [
"code",
"domain",
"path",
"status"
],
"properties": {
"code": {
"type": "string",
"format": "constant",
"description": "Short identifier for the error, suitable for indicating the specific error within client code"
},
"path": {
"type": "string",
"format": "json-path",
"description": "<ul>\n<li style='margin-left: 12px;'>JSONPath referring to a field containing an error</li>\n<strong style='margin-left: 12px;'>OR</strong>\n<li style='margin-left: 12px;'>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>\n</ul>"
},
"domain": {
"type": "string",
"description": "Domain name"
},
"status": {
"type": "integer",
"description": "HTTP status code that would return for a single check"
},
"message": {
"type": "string",
"description": "Human-readable, English description of the error"
}
}
}
DomainAvailableResponse
{
"required": [
"domain",
"available",
"definitive"
],
"properties": {
"price": {
"type": "integer",
"format": "currency-micro-unit",
"description": "Price of the domain excluding taxes or fees. Only returned if tld is offered"
},
"domain": {
"type": "string",
"description": "Domain name"
},
"period": {
"type": "integer",
"format": "integer-positive",
"description": "Number of years included in the price. Only returned if tld is offered"
},
"currency": {
"type": "string",
"format": "iso-currency-code",
"default": "USD",
"description": "Currency in which the `price` is listed. Only returned if tld is offered"
},
"available": {
"type": "boolean",
"description": "Whether or not the domain name is available"
},
"definitive": {
"type": "boolean",
"description": "Whether or not the `available` answer has been definitively verified with the registry"
}
}
}
DomainContacts
{
"required": [
"contactRegistrant"
],
"properties": {
"contactTech": {
"$ref": "#/components/schemas/Contact"
},
"contactAdmin": {
"$ref": "#/components/schemas/Contact"
},
"contactBilling": {
"$ref": "#/components/schemas/Contact"
},
"contactRegistrant": {
"$ref": "#/components/schemas/Contact"
}
}
}
DomainContactsCreateV2
{
"type": "object",
"properties": {
"tech": {
"$ref": "#/components/schemas/ContactDomainCreate"
},
"admin": {
"$ref": "#/components/schemas/ContactDomainCreate"
},
"techId": {
"type": "string",
"description": "Unique identifier of the contact that the user wants to use for the domain tech contact. This can be specified instead of the `tech` property.\n"
},
"adminId": {
"type": "string",
"description": "Unique identifier of the contact that the user wants to use for the domain admin contact. This can be specified instead of the `admin` property.\n"
},
"billing": {
"$ref": "#/components/schemas/ContactDomainCreate"
},
"billingId": {
"type": "string",
"description": "Unique identifier of the contact that the user wants to use for the domain billing contact. This can be specified instead of the `billing` property.\n"
},
"registrant": {
"$ref": "#/components/schemas/ContactDomainCreate"
},
"registrantId": {
"type": "string",
"description": "Unique identifier of the contact that the user wants to use for the domain registrant contact. This can be specified instead of the `registrant` property.\n"
}
}
}
DomainContactsV2
{
"properties": {
"tech": {
"$ref": "#/components/schemas/ContactDomain"
},
"admin": {
"$ref": "#/components/schemas/ContactDomain"
},
"billing": {
"$ref": "#/components/schemas/ContactDomain"
},
"registrant": {
"$ref": "#/components/schemas/ContactDomain"
}
},
"additionalProperties": false
}
DomainDetail
{
"required": [
"domainId",
"domain",
"status",
"expirationProtected",
"holdRegistrar",
"locked",
"privacy",
"renewAuto",
"renewDeadline",
"transferProtected",
"createdAt",
"authCode",
"nameServers",
"contactRegistrant",
"contactBilling",
"contactAdmin",
"contactTech"
],
"properties": {
"domain": {
"type": "string",
"description": "Name of the domain"
},
"locked": {
"type": "boolean",
"description": "Whether or not the domain is locked to prevent transfers"
},
"status": {
"type": "string",
"description": "Processing status of the domain<br/><ul>\n<li><strong style='margin-left: 12px;'>ACTIVE</strong> - All is well</li>\n<li><strong style='margin-left: 12px;'>AWAITING*</strong> - System is waiting for the end-user to complete an action</li>\n<li><strong style='margin-left: 12px;'>CANCELLED*</strong> - Domain has been cancelled, and may or may not be reclaimable</li>\n<li><strong style='margin-left: 12px;'>CONFISCATED</strong> - Domain has been confiscated, usually for abuse, chargeback, or fraud</li>\n<li><strong style='margin-left: 12px;'>DISABLED*</strong> - Domain has been disabled</li>\n<li><strong style='margin-left: 12px;'>EXCLUDED*</strong> - Domain has been excluded from Firehose registration</li>\n<li><strong style='margin-left: 12px;'>EXPIRED*</strong> - Domain has expired</li>\n<li><strong style='margin-left: 12px;'>FAILED*</strong> - Domain has failed a required action, and the system is no longer retrying</li>\n<li><strong style='margin-left: 12px;'>HELD*</strong> - Domain has been placed on hold, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>LOCKED*</strong> - Domain has been locked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>PARKED*</strong> - Domain has been parked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>PENDING*</strong> - Domain is working its way through an automated workflow</li>\n<li><strong style='margin-left: 12px;'>RESERVED*</strong> - Domain is reserved, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>REVERTED</strong> - Domain has been reverted, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>SUSPENDED*</strong> - Domain has been suspended, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>TRANSFERRED*</strong> - Domain has been transferred out</li>\n<li><strong style='margin-left: 12px;'>UNKNOWN</strong> - Domain is in an unknown state</li>\n<li><strong style='margin-left: 12px;'>UNLOCKED*</strong> - Domain has been unlocked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>UNPARKED*</strong> - Domain has been unparked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>UPDATED*</strong> - Domain ownership has been transferred to another account</li>\n</ul>"
},
"expires": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain will expire"
},
"privacy": {
"type": "boolean",
"description": "Whether or not the domain has privacy protection"
},
"authCode": {
"type": "string",
"description": "Authorization code for transferring the Domain"
},
"domainId": {
"type": "number",
"format": "double",
"description": "Unique identifier for this Domain"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain was created"
},
"deletedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain was deleted"
},
"renewAuto": {
"type": "boolean",
"description": "Whether or not the domain is configured to automatically renew"
},
"contactTech": {
"$ref": "#/components/schemas/Contact"
},
"exposeWhois": {
"type": "boolean",
"description": "Whether or not the domain contact details should be shown in the WHOIS"
},
"nameServers": {
"type": "array",
"items": {
"type": "string",
"format": "host-name"
},
"description": "Fully-qualified domain names for DNS servers"
},
"contactAdmin": {
"$ref": "#/components/schemas/Contact"
},
"subaccountId": {
"type": "string",
"description": "Reseller subaccount shopperid who can manage the domain"
},
"holdRegistrar": {
"type": "boolean",
"description": "Whether or not the domain is on-hold by the registrar"
},
"renewDeadline": {
"type": "string",
"format": "date-time",
"description": "Date the domain must renew on"
},
"verifications": {
"$ref": "#/components/schemas/VerificationsDomain"
},
"contactBilling": {
"$ref": "#/components/schemas/Contact"
},
"contactRegistrant": {
"$ref": "#/components/schemas/Contact"
},
"transferProtected": {
"type": "boolean",
"description": "Whether or not the domain is protected from transfer"
},
"registrarCreatedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain was created by the registrar"
},
"expirationProtected": {
"type": "boolean",
"description": "Whether or not the domain is protected from expiration"
},
"transferAwayEligibleAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain is eligible to transfer"
}
}
}
DomainDetailV2
{
"required": [
"domainId",
"domain",
"status",
"expirationProtected",
"holdRegistrar",
"locked",
"privacy",
"renewAuto",
"renewDeadline",
"transferProtected",
"createdAt",
"authCode",
"nameServers",
"contacts"
],
"properties": {
"domain": {
"type": "string",
"format": "domain",
"description": "Name of the domain"
},
"locked": {
"type": "boolean",
"description": "Whether or not the domain is locked to prevent transfers"
},
"status": {
"enum": [
"ACTIVE",
"CANCELLED",
"DELETED_REDEEMABLE",
"EXPIRED",
"FAILED",
"LOCKED_REGISTRAR",
"PARKED",
"HELD_REGISTRAR",
"OWNERSHIP_CHANGED",
"PENDING_TRANSFER",
"PENDING_REGISTRATION",
"REPOSSESSED",
"SUSPENDED",
"TRANSFERRED"
],
"type": "string",
"description": "The current status of the domain<br/><ul><li><strong style='margin-left: 12px;'>ACTIVE</strong> - Domain has been registered and is active.</li><li><strong style='margin-left: 12px;'>CANCELLED</strong> - Domain has been cancelled by the user or system, and is not be reclaimable.</li><li><strong style='margin-left: 12px;'>DELETED_REDEEMABLE</strong> - Domain is deleted but is redeemable.</li><li><strong style='margin-left: 12px;'>EXPIRED</strong> - Domain has expired.</li><li><strong style='margin-left: 12px;'>FAILED</strong> - Domain registration or transfer error.</li><li><strong style='margin-left: 12px;'>LOCKED_REGISTRAR</strong> - Domain is locked at the registrar - this is usually the result of a spam, abuse, etc.</li><li><strong style='margin-left: 12px;'>PARKED</strong> - Domain has been parked.</li><li><strong style='margin-left: 12px;'>HELD_REGISTRAR</strong> - Domain is held at the registrar and cannot be transferred or modified - this is usually the result of a dispute.</li><li><strong style='margin-left: 12px;'>OWNERSHIP_CHANGED</strong> - Domain has been moved to another account.</li><li><strong style='margin-left: 12px;'>PENDING_TRANSFER</strong> - Domain transfer has been requested and is pending the transfer process.</li><li><strong style='margin-left: 12px;'>PENDING_REGISTRATION</strong> - Domain is pending setup at the registry.</li><li><strong style='margin-left: 12px;'>REPOSSESSED</strong> - Domain has been confiscated - this is usually the result of a chargeback, fraud, abuse, etc.).</li><li><strong style='margin-left: 12px;'>SUSPENDED</strong> - Domain is in violation and has been suspended.</li><li><strong style='margin-left: 12px;'>TRANSFERRED</strong> - Domain has been transferred to another registrar.</li></ul>"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Action"
},
"description": "List of current actions in progress for this domain"
},
"privacy": {
"type": "boolean",
"description": "Whether or not the domain has privacy protection"
},
"renewal": {
"$ref": "#/components/schemas/RenewalDetails"
},
"authCode": {
"type": "string",
"description": "Authorization code for transferring the Domain"
},
"contacts": {
"$ref": "#/components/schemas/DomainContactsV2"
},
"domainId": {
"type": "string",
"description": "Unique identifier for this Domain"
},
"createdAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain was created"
},
"deletedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain was deleted"
},
"expiresAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain will expire"
},
"hostnames": {
"type": "array",
"items": {
"type": "string",
"format": "host-name"
},
"description": "Hostnames owned by the domain"
},
"renewAuto": {
"type": "boolean",
"description": "Whether or not the domain is configured to automatically renew"
},
"modifiedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain was last modified"
},
"nameServers": {
"type": "array",
"items": {
"type": "string",
"format": "host-name"
},
"description": "Fully-qualified domain names for DNS servers"
},
"subaccountId": {
"type": "string",
"description": "Reseller subaccount shopperid who can manage the domain"
},
"dnssecRecords": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainDnssec"
},
"description": "List of active DNSSEC records for this domain"
},
"holdRegistrar": {
"type": "boolean",
"description": "Whether or not the domain is on-hold by the registrar"
},
"renewDeadline": {
"type": "string",
"format": "iso-datetime",
"description": "Date the domain must renew on"
},
"verifications": {
"$ref": "#/components/schemas/VerificationsDomainV2"
},
"transferProtected": {
"type": "boolean",
"description": "Whether or not the domain is protected from transfer"
},
"registrarCreatedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain was created by the registrar"
},
"expirationProtected": {
"type": "boolean",
"description": "Whether or not the domain is protected from expiration"
},
"registryStatusCodes": {
"type": "array",
"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"
],
"type": "string"
},
"description": "The current registry status codes of the domain<br/><ul><li><strong style='margin-left: 12px;'>ADD_PERIOD</strong> - This grace period is provided after the initial registration of a domain name.</li><li><strong style='margin-left: 12px;'>AUTO_RENEW_PERIOD</strong> - This grace period is provided after a domain name registration period expires and is extended (renewed) automatically by the registry.</li><li><strong style='margin-left: 12px;'>CLIENT_DELETE_PROHIBITED</strong> - This status code tells your domain's registry to reject requests to delete the domain.</li><li><strong style='margin-left: 12px;'>CLIENT_HOLD</strong> - This status code tells your domain's registry to not activate your domain in the DNS and as a consequence, it will not resolve.</li><li><strong style='margin-left: 12px;'>CLIENT_RENEW_PROHIBITED</strong> - This status code tells your domain's registry to reject requests to renew your domain.</li><li><strong style='margin-left: 12px;'>CLIENT_TRANSFER_PROHIBITED</strong> - This status code tells your domain's registry to reject requests to transfer the domain from your current registrar to another.</li><li><strong style='margin-left: 12px;'>CLIENT_UPDATE_PROHIBITED</strong> - This status code tells your domain's registry to reject requests to update the domain.</li><li><strong style='margin-left: 12px;'>INACTIVE</strong> - This status code indicates that delegation information (name servers) has not been associated with your domain.</li><li><strong style='margin-left: 12px;'>OK</strong> - This is the standard status for a domain, meaning it has no pending operations or prohibitions.</li><li><strong style='margin-left: 12px;'>PENDING_CREATE</strong> - This status code indicates that a request to create your domain has been received and is being processed.</li><li><strong style='margin-left: 12px;'>PENDING_DELETE</strong> - This status code indicates that the domain is either in a redemption period if combined with either REDEMPTION_PERIOD or PENDING_RESTORE, if not combined with these, then indicates that the redemption period for the domain has ended and domain will be be purged and dropped from the registry database.</li><li><strong style='margin-left: 12px;'>PENDING_RENEW</strong> - This status code indicates that a request to renew your domain has been received and is being processed.</li><li><strong style='margin-left: 12px;'>PENDING_RESTORE</strong> - This status code indicates that your registrar has asked the registry to restore your domain that was in REDEMPTION_PERIOD status</li><li><strong style='margin-left: 12px;'>PENDING_TRANSFER</strong> - This status code indicates that a request to transfer your domain to a new registrar has been received and is being processed.</li><li><strong style='margin-left: 12px;'>PENDING_UPDATE</strong> - This status code indicates that a request to update your domain has been received and is being processed.</li><li><strong style='margin-left: 12px;'>REDEMPTION_PERIOD</strong> - This status code indicates that your registrar has asked the registry to delete your domain.</li><li><strong style='margin-left: 12px;'>RENEW_PERIOD</strong> - This grace period is provided after a domain name registration period is explicitly extended (renewed) by the registrar.</li><li><strong style='margin-left: 12px;'>SERVER_DELETE_PROHIBITED</strong> - This status code prevents your domain from being deleted. </li><li><strong style='margin-left: 12px;'>SERVER_HOLD</strong> - This status code is set by your domain's Registry Operator. Your domain is not activated in the DNS.</li><li><strong style='margin-left: 12px;'>SERVER_RENEW_PROHIBITED</strong> - This status code indicates your domain's Registry Operator will not allow your registrar to renew your domain.</li><li><strong style='margin-left: 12px;'>SERVER_TRANSFER_PROHIBITED</strong> - This status code prevents your domain from being transferred from your current registrar to another. </li><li><strong style='margin-left: 12px;'>SERVER_UPDATE_PROHIBITED</strong> - This status code locks your domain preventing it from being updated.</li><li><strong style='margin-left: 12px;'>TRANSFER_PERIOD</strong> - This grace period is provided after the successful transfer of a domain name from one registrar to another. </li></ul>"
},
"transferAwayEligibleAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain is eligible to transfer"
}
},
"additionalProperties": false
}
DomainDnssec
{
"required": [
"algorithm"
],
"properties": {
"flags": {
"enum": [
"ZSK",
"KSK"
],
"type": "string",
"description": "This identifies the key type; either a Zone-Signing Key or a Key-Signing Key<br/><ul><li><strong style='margin-left: 12px;'>ZSK</strong> - [256] Zone-Signing Key</li><li><strong style='margin-left: 12px;'>KSK</strong> - [257] Key-Signing Key</li></ul>"
},
"digest": {
"type": "string",
"description": "The digest is an alpha-numeric value"
},
"keyTag": {
"type": "integer",
"format": "integer-positive",
"maximum": 65536,
"description": "This is an integer value less than 65536 used to identify the DNSSEC record for the domain name."
},
"algorithm": {
"enum": [
"RSAMD5",
"DH",
"DSA",
"RSASHA1",
"DSA_NSEC3_SHA1",
"RSASHA1_NSEC3_SHA1",
"RSASHA256",
"RSASHA512",
"ECC_GOST",
"ECDSAP256SHA256",
"ECDSAP384SHA384",
"ED25519",
"ED448",
"PRIVATEDNS",
"PRIVATEOID"
],
"type": "string",
"description": "This identifies the cryptographic algorithm used to generate the signature<br/><ul><li><strong style='margin-left: 12px;'>RSAMD5</strong> - [01] DRSA/MD5 </li><li><strong style='margin-left: 12px;'>DSA</strong> - [03] DSA/SHA1</li><li><strong style='margin-left: 12px;'>RSASHA1</strong> - [05] RSA/SHA-1</li><li><strong style='margin-left: 12px;'>DSA_NSEC3_SHA1</strong> - [06] DSA-NSEC3-SHA1</li><li><strong style='margin-left: 12px;'>RSASHA1_NSEC3_SHA1</strong> - [07] RSASHA1-NSEC3-SHA1</li><li><strong style='margin-left: 12px;'>RSASHA256</strong> - [08] RSA/SHA-256</li><li><strong style='margin-left: 12px;'>RSASHA512</strong> - [10] RSA/SHA-512</li><li><strong style='margin-left: 12px;'>ECC_GOST</strong> - [12] GOST R 34.10-2001</li><li><strong style='margin-left: 12px;'>ECDSAP256SHA256</strong> - [13] ECDSA Curve P-256 with SHA-256</li><li><strong style='margin-left: 12px;'>ECDSAP384SHA384</strong> - [14] ECDSA Curve P-384 with SHA-384</li><li><strong style='margin-left: 12px;'>ED25519</strong> - [15] Ed25519</li><li><strong style='margin-left: 12px;'>ED448</strong> - [16] Ed448</li></ul>"
},
"publicKey": {
"type": "string",
"description": "Registries use this value to encrypt DS records. Decryption requires a matching public key"
},
"digestType": {
"enum": [
"SHA1",
"SHA256",
"GOST",
"SHA384"
],
"type": "string",
"description": "This identifies the algorithm used to construct the digest<br/><ul><li><strong style='margin-left: 12px;'>SHA1</strong> - [01] SHA-1</li><li><strong style='margin-left: 12px;'>SHA256</strong> - [02] SHA-256</li><li><strong style='margin-left: 12px;'>GOST</strong> - [03] GOST R 34.11-94</li><li><strong style='margin-left: 12px;'>SHA384</strong> - [04] SHA-384</li></ul>"
},
"maxSignatureLife": {
"type": "integer",
"format": "integer-positive",
"description": "This specifies the validity period for the signature. The value is expressed in seconds. You can use any integer value larger than zero"
}
}
}
DomainForwarding
{
"required": [
"fqdn",
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "url",
"description": "Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)"
},
"fqdn": {
"type": "string",
"description": "The fqdn (domain or sub domain) to forward (ex somedomain.com or sub.somedomain.com)"
},
"mask": {
"$ref": "#/components/schemas/DomainForwardingMask"
},
"type": {
"enum": [
"MASKED",
"REDIRECT_PERMANENT",
"REDIRECT_TEMPORARY"
],
"type": "string",
"default": "REDIRECT_PERMANENT",
"description": "The type of fowarding to implement<br/><ul><li><strong style='margin-left: 12px;'>MASKED</strong> - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.</li><li><strong style='margin-left: 12px;'>REDIRECT_PERMANENT*</strong> - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.</li><li><strong style='margin-left: 12px;'>REDIRECT_TEMPORARY</strong> - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.</li></ul>"
}
}
}
DomainForwardingCreate
{
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "url",
"description": "Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)"
},
"mask": {
"$ref": "#/components/schemas/DomainForwardingMask"
},
"type": {
"enum": [
"MASKED",
"REDIRECT_PERMANENT",
"REDIRECT_TEMPORARY"
],
"type": "string",
"default": "REDIRECT_PERMANENT",
"description": "The type of fowarding to implement<br/><ul><li><strong style='margin-left: 12px;'>MASKED</strong> - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.</li><li><strong style='margin-left: 12px;'>REDIRECT_PERMANENT*</strong> - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.</li><li><strong style='margin-left: 12px;'>REDIRECT_TEMPORARY</strong> - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.</li></ul>"
}
}
}
DomainForwardingMask
{
"properties": {
"title": {
"type": "string",
"description": "Displays at the top of the browser window and in search results."
},
"keywords": {
"type": "string",
"description": "A list of comma-separated keywords that describes the content and purpose of your website."
},
"description": {
"type": "string",
"description": "A short description of your website to display in search engine results."
}
}
}
DomainNotification
{
"required": [
"notificationId",
"type",
"resource",
"resourceType",
"status",
"addedAt"
],
"properties": {
"type": {
"enum": [
"AUTH_CODE_PURCHASE",
"AUTH_CODE_REGENERATE",
"AUTO_RENEWAL",
"BACKORDER",
"BACKORDER_PURCHASE",
"BACKORDER_DELETE",
"BACKORDER_UPDATE",
"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"
],
"type": "string",
"description": "The type of action the notification relates to"
},
"status": {
"enum": [
"AWAITING",
"CANCELLED",
"FAILED",
"PENDING",
"SUCCESS"
],
"type": "string",
"description": "The resulting status of the action."
},
"addedAt": {
"type": "string",
"format": "iso-datetime",
"default": "",
"description": "The date the notification was added"
},
"metadata": {
"type": "object",
"default": "",
"description": "The notification data for the given type as specifed by GET /v2/customers/{customerId}/domains/notifications/schema"
},
"resource": {
"type": "string",
"default": "",
"description": "The resource the notification pertains to."
},
"requestId": {
"type": "string",
"description": "A client provided identifier (via X-Request-Id header) indicating the request this notification is for"
},
"resourceType": {
"enum": [
"CONTACT",
"DOMAIN",
"HOST"
],
"type": "string",
"description": "The type of resource the notification relates to"
},
"notificationId": {
"type": "string",
"default": "",
"description": "The notification ID to be used in POST /v2/customers/{customerId}/domains/notifications to acknowledge the notification"
}
}
}
DomainNotificationType
{
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"AUTH_CODE_PURCHASE",
"AUTH_CODE_REGENERATE",
"AUTO_RENEWAL",
"BACKORDER",
"BACKORDER_PURCHASE",
"BACKORDER_DELETE",
"BACKORDER_UPDATE",
"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"
],
"type": "string",
"description": "The notification type"
}
}
}
DomainPurchase
{
"required": [
"domain",
"consent"
],
"properties": {
"domain": {
"type": "string",
"format": "domain",
"description": "For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked"
},
"period": {
"type": "integer",
"format": "integer-positive",
"default": 1,
"maximum": 10,
"minimum": 1
},
"consent": {
"$ref": "#/components/schemas/Consent"
},
"privacy": {
"type": "boolean",
"default": false
},
"renewAuto": {
"type": "boolean",
"default": true
},
"contactTech": {
"$ref": "#/components/schemas/Contact"
},
"nameServers": {
"type": "array",
"items": {
"type": "string",
"format": "host-name"
}
},
"contactAdmin": {
"$ref": "#/components/schemas/Contact"
},
"contactBilling": {
"$ref": "#/components/schemas/Contact"
},
"contactRegistrant": {
"$ref": "#/components/schemas/Contact"
}
}
}
DomainPurchaseResponse
{
"required": [
"orderId",
"itemCount",
"total"
],
"properties": {
"total": {
"type": "integer",
"format": "currency-micro-unit",
"description": "Total cost of the domain and any selected add-ons"
},
"orderId": {
"type": "integer",
"format": "int64",
"description": "Unique identifier of the order processed to purchase the domain"
},
"currency": {
"type": "string",
"format": "iso-currency-code",
"default": "USD",
"description": "Currency in which the `total` is listed"
},
"itemCount": {
"type": "integer",
"format": "integer-positive",
"description": "Number items included in the order"
}
}
}
DomainPurchaseV2
{
"required": [
"domain",
"consent"
],
"properties": {
"domain": {
"type": "string",
"format": "domain",
"pattern": "^[^.]{1,63}.[^.]{2,}$",
"description": "For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked"
},
"period": {
"type": "integer",
"format": "integer-positive",
"default": 1,
"maximum": 10,
"minimum": 1,
"pattern": "^[0-9]+$"
},
"consent": {
"$ref": "#/components/schemas/ConsentV2"
},
"privacy": {
"type": "boolean",
"default": false
},
"contacts": {
"$ref": "#/components/schemas/DomainContactsCreateV2"
},
"metadata": {
"type": "object",
"description": "The domain eligibility data fields as specified by GET /v2/customers/{customerId}/domains/register/schema/{tld}"
},
"renewAuto": {
"type": "boolean",
"default": true
},
"nameServers": {
"type": "array",
"items": {
"type": "string",
"format": "host-name"
},
"maxItems": 2
}
},
"additionalProperties": false
}
DomainRedeemV2
{
"required": [
"consent"
],
"properties": {
"consent": {
"$ref": "#/components/schemas/ConsentRedemption"
}
},
"additionalProperties": false
}
DomainRenew
{
"properties": {
"period": {
"type": "integer",
"format": "integer-positive",
"maximum": 10,
"minimum": 1,
"description": "Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to `period` specified during original purchase"
}
}
}
DomainRenewV2
{
"required": [
"consent",
"expires"
],
"properties": {
"period": {
"type": "integer",
"format": "integer-positive",
"maximum": 10,
"minimum": 1,
"pattern": "^[0-9]+$",
"description": "Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to `period` specified during original purchase"
},
"consent": {
"$ref": "#/components/schemas/ConsentRenew"
},
"expires": {
"type": "string",
"format": "iso-datetime",
"description": "Current date when this domain will expire"
}
},
"additionalProperties": false
}
DomainSuggestion
{
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Suggested domain name"
}
}
}
DomainSummary
{
"required": [
"domainId",
"domain",
"status",
"expirationProtected",
"holdRegistrar",
"locked",
"privacy",
"renewAuto",
"renewDeadline",
"transferProtected",
"createdAt",
"contactRegistrant"
],
"properties": {
"domain": {
"type": "string",
"description": "Name of the domain"
},
"locked": {
"type": "boolean",
"description": "Whether or not the domain is locked to prevent transfers"
},
"status": {
"type": "string",
"description": "Processing status of the domain<br/><ul>\n<li><strong style='margin-left: 12px;'>ACTIVE</strong> - All is well</li>\n<li><strong style='margin-left: 12px;'>AWAITING*</strong> - System is waiting for the end-user to complete an action</li>\n<li><strong style='margin-left: 12px;'>CANCELLED*</strong> - Domain has been cancelled, and may or may not be reclaimable</li>\n<li><strong style='margin-left: 12px;'>CONFISCATED</strong> - Domain has been confiscated, usually for abuse, chargeback, or fraud</li>\n<li><strong style='margin-left: 12px;'>DISABLED*</strong> - Domain has been disabled</li>\n<li><strong style='margin-left: 12px;'>EXCLUDED*</strong> - Domain has been excluded from Firehose registration</li>\n<li><strong style='margin-left: 12px;'>EXPIRED*</strong> - Domain has expired</li>\n<li><strong style='margin-left: 12px;'>FAILED*</strong> - Domain has failed a required action, and the system is no longer retrying</li>\n<li><strong style='margin-left: 12px;'>HELD*</strong> - Domain has been placed on hold, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>LOCKED*</strong> - Domain has been locked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>PARKED*</strong> - Domain has been parked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>PENDING*</strong> - Domain is working its way through an automated workflow</li>\n<li><strong style='margin-left: 12px;'>RESERVED*</strong> - Domain is reserved, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>REVERTED</strong> - Domain has been reverted, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>SUSPENDED*</strong> - Domain has been suspended, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>TRANSFERRED*</strong> - Domain has been transferred out</li>\n<li><strong style='margin-left: 12px;'>UNKNOWN</strong> - Domain is in an unknown state</li>\n<li><strong style='margin-left: 12px;'>UNLOCKED*</strong> - Domain has been unlocked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>UNPARKED*</strong> - Domain has been unparked, and likely requires intervention from Support</li>\n<li><strong style='margin-left: 12px;'>UPDATED*</strong> - Domain ownership has been transferred to another account</li>\n</ul>"
},
"expires": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain will expire"
},
"privacy": {
"type": "boolean",
"description": "Whether or not the domain has privacy protection"
},
"authCode": {
"type": "string",
"description": "Authorization code for transferring the Domain"
},
"domainId": {
"type": "number",
"format": "double",
"description": "Unique identifier for this Domain"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain was created"
},
"deletedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain was deleted"
},
"renewAuto": {
"type": "boolean",
"description": "Whether or not the domain is configured to automatically renew"
},
"renewable": {
"type": "boolean",
"description": "Whether or not the domain is eligble for renewal based on status"
},
"contactTech": {
"$ref": "#/components/schemas/Contact"
},
"exposeWhois": {
"type": "boolean",
"description": "Whether or not the domain contact details should be shown in the WHOIS"
},
"nameServers": {
"type": "array",
"items": {
"type": "string",
"format": "host-name"
},
"description": "Fully-qualified domain names for DNS servers"
},
"contactAdmin": {
"$ref": "#/components/schemas/Contact"
},
"holdRegistrar": {
"type": "boolean",
"description": "Whether or not the domain is on-hold by the registrar"
},
"renewDeadline": {
"type": "string",
"format": "date-time",
"description": "Date the domain must renew on"
},
"contactBilling": {
"$ref": "#/components/schemas/Contact"
},
"contactRegistrant": {
"$ref": "#/components/schemas/Contact"
},
"transferProtected": {
"type": "boolean",
"description": "Whether or not the domain is protected from transfer"
},
"registrarCreatedAt": {
"type": "string",
"format": "iso-datetime",
"description": "Date and time when this domain was created by the registrar"
},
"expirationProtected": {
"type": "boolean",
"description": "Whether or not the domain is protected from expiration"
},
"transferAwayEligibleAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this domain is eligible to transfer"
}
}
}
DomainTransferAuthCode
{
"type": "object",
"required": [
"authCode"
],
"properties": {
"authCode": {
"type": "string",
"description": "Authorization code for transferring the Domain"
}
}
}
DomainTransferIn
{
"required": [
"authCode",
"consent"
],
"properties": {
"period": {
"type": "integer",
"format": "integer-positive",
"default": 1,
"maximum": 10,
"minimum": 1,
"description": "Can be more than 1 but no more than 10 years total including current registration length"
},
"consent": {
"$ref": "#/components/schemas/Consent"
},
"privacy": {
"type": "boolean",
"default": false,
"description": "Whether or not privacy has been requested"
},
"authCode": {
"type": "string",
"description": "Authorization code from registrar for transferring a domain"
},
"renewAuto": {
"type": "boolean",
"default": true,
"description": "Whether or not the domain should be configured to automatically renew"
},
"contactTech": {
"$ref": "#/components/schemas/Contact"
},
"contactAdmin": {
"$ref": "#/components/schemas/Contact"
},
"contactBilling": {
"$ref": "#/components/schemas/Contact"
},
"contactRegistrant": {
"$ref": "#/components/schemas/Contact"
}
}
}
DomainTransferInV2
{
"required": [
"authCode",
"consent"
],
"properties": {
"period": {
"type": "integer",
"format": "integer-positive",
"default": 1,
"maximum": 10,
"minimum": 1,
"pattern": "^[0-9]+$",
"description": "Can be more than 1 but no more than 10 years total including current registration length"
},
"consent": {
"$ref": "#/components/schemas/ConsentV2"
},
"privacy": {
"type": "boolean",
"default": false,
"description": "Whether or not privacy has been requested"
},
"authCode": {
"type": "string",
"description": "Authorization code from registrar for transferring a domain"
},
"contacts": {
"$ref": "#/components/schemas/DomainContactsCreateV2"
},
"metadata": {
"type": "object",
"description": "The domain eligibility data fields as specified by GET /v2/customers/{customerId}/domains/register/schema/{tld}"
},
"renewAuto": {
"type": "boolean",
"default": true,
"description": "Whether or not the domain should be configured to automatically renew"
},
"identityDocumentId": {
"type": "string",
"description": "Unique identifier of the identify document that the user wants to associate with the domain being transferred in. This is required only if the gaining registry has a requirement for an approved identity document"
}
},
"additionalProperties": false
}
DomainUpdate
{
"properties": {
"locked": {
"type": "boolean",
"description": "Whether or not the domain should be locked to prevent transfers"
},
"consent": {
"$ref": "#/components/schemas/ConsentDomainUpdate"
},
"renewAuto": {
"type": "boolean",
"description": "Whether or not the domain should be configured to automatically renew"
},
"exposeWhois": {
"type": "boolean",
"description": "Whether or not the domain contact details should be shown in the WHOIS"
},
"nameServers": {
"type": "array",
"items": {
"format": "host-name"
},
"description": "Fully-qualified domain names for Name Servers to associate with the domain"
},
"subaccountId": {
"type": "string",
"description": "Reseller subaccount shopperid who can manage the domain"
}
}
}
DomainsContactsBulk
{
"required": [
"domains"
],
"properties": {
"domains": {
"type": "array",
"items": {
"type": "string",
"format": "domain"
},
"description": "An array of domain names to be validated against. Alternatively, you can specify the extracted tlds. However, full domain names are required if the tld is `uk`"
},
"entityType": {
"enum": [
"ABORIGINAL",
"ASSOCIATION",
"CITIZEN",
"CORPORATION",
"EDUCATIONAL",
"GOVERNMENT",
"HOSPITAL",
"INDIAN_BAND",
"LEGAL_REPRESENTATIVE",
"LIBRARY_ARCHIVE_MUSEUM",
"MARK_REGISTERED",
"MARK_TRADE",
"PARTNERSHIP",
"POLITICAL_PARTY",
"RESIDENT_PERMANENT",
"TRUST",
"UNION"
],
"type": "string",
"description": "Canadian Presence Requirement (CA)"
},
"contactTech": {
"$ref": "#/components/schemas/Contact"
},
"contactAdmin": {
"$ref": "#/components/schemas/Contact"
},
"contactBilling": {
"$ref": "#/components/schemas/Contact"
},
"contactPresence": {
"$ref": "#/components/schemas/Contact"
},
"contactRegistrant": {
"$ref": "#/components/schemas/Contact"
}
}
}
DomainsGetForwardingInfoResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DomainForwarding"
}
}
Error
{
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"format": "constant",
"description": "Short identifier for the error, suitable for indicating the specific error within client code"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorField"
},
"description": "List of the specific fields, and the errors found with their contents"
},
"message": {
"type": "string",
"description": "Human-readable, English description of the error"
}
}
}
ErrorDomainContactsValidate
{
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"format": "constant",
"description": "Short identifier for the error, suitable for indicating the specific error within client code"
},
"stack": {
"type": "array",
"items": {
"type": "string"
},
"description": "Stack trace indicating where the error occurred.<br/>NOTE: This attribute <strong>MAY</strong> be included for Development and Test environments. However, it <strong>MUST NOT</strong> be exposed from OTE nor Production systems"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorFieldDomainContactsValidate"
},
"description": "List of the specific fields, and the errors found with their contents"
},
"message": {
"type": "string",
"description": "Human-readable, English description of the error"
}
}
}
ErrorField
{
"required": [
"path",
"code"
],
"properties": {
"code": {
"type": "string",
"format": "constant",
"description": "Short identifier for the error, suitable for indicating the specific error within client code"
},
"path": {
"type": "string",
"format": "json-path",
"description": "<ul>\n<li style='margin-left: 12px;'>JSONPath referring to a field containing an error</li>\n<strong style='margin-left: 12px;'>OR</strong>\n<li style='margin-left: 12px;'>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li>\n</ul>"
},
"message": {
"type": "string",
"description": "Human-readable, English description of the problem with the contents of the field"
},
"pathRelated": {
"type": "string",
"format": "json-path",
"description": "JSONPath referring to a field containing an error, which is referenced by `path`"
}
}
}
ErrorFieldDomainContactsValidate
{
"required": [
"code",
"domains",
"path"
],
"properties": {
"code": {
"type": "string",
"format": "constant",
"description": "Short identifier for the error, suitable for indicating the specific error within client code"
},
"path": {
"type": "string",
"format": "json-path",
"description": "1) JSONPath referring to the field within the data containing an error<br/>or<br/>2) JSONPath referring to an object containing an error"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is [\"test1.com\", \"test2.uk\", \"net\"], and the field is invalid for com and net, then one of the `fields` in response will have [\"test1.com\", \"net\"] as `domains`"
},
"message": {
"type": "string",
"description": "Human-readable, English description of the problem with the contents of the field"
},
"pathRelated": {
"type": "string",
"format": "json-path",
"description": "JSONPath referring to the field on the object referenced by `path` containing an error"
}
}
}
ErrorLimit
{
"required": [
"retryAfterSec",
"code"
],
"properties": {
"code": {
"type": "string",
"format": "constant",
"description": "Short identifier for the error, suitable for indicating the specific error within client code"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorField"
},
"description": "List of the specific fields, and the errors found with their contents"
},
"message": {
"type": "string",
"description": "Human-readable, English description of the error"
},
"retryAfterSec": {
"type": "integer",
"format": "integer-positive",
"description": "Number of seconds to wait before attempting a similar request"
}
}
}
| Version | Endpoints | Schemas | Ingested | Status |
|---|---|---|---|---|
| 1.0.0 | 53 | 104 | 2026-05-11 | current |
| 1.0.0 | 53 | 104 | 2026-04-16 |