{ "openapi": "3.1.1", "info": { "title": "GoDaddy Domains API v1", "version": "1.0.0", "description": "API for managing domains, contacts, hosts, and related operations" }, "servers": [ { "url": "https://api.godaddy.com", "description": "Production" } ], "tags": [ { "name": "Manage Domain Settings" }, { "name": "Register and Renew Domains" }, { "name": "Manage DNS" }, { "name": "Transfer Domains" }, { "name": "Find Domains" } ], "paths": { "/v1/domains": { "get": { "tags": [ "Manage Domain Settings" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Only include results with `status` value in the specified set", "in": "query", "name": "statuses", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "ACTIVE", "AWAITING_CLAIM_ACK", "AWAITING_DOCUMENT_AFTER_TRANSFER", "AWAITING_DOCUMENT_AFTER_UPDATE_ACCOUNT", "AWAITING_DOCUMENT_UPLOAD", "AWAITING_FAILED_TRANSFER_WHOIS_PRIVACY", "AWAITING_PAYMENT", "AWAITING_RENEWAL_TRANSFER_IN_COMPLETE", "AWAITING_TRANSFER_IN_ACK", "AWAITING_TRANSFER_IN_AUTH", "AWAITING_TRANSFER_IN_AUTO", "AWAITING_TRANSFER_IN_WHOIS", "AWAITING_TRANSFER_IN_WHOIS_FIX", "AWAITING_VERIFICATION_ICANN", "AWAITING_VERIFICATION_ICANN_MANUAL", "CANCELLED", "CANCELLED_HELD", "CANCELLED_REDEEMABLE", "CANCELLED_TRANSFER", "CONFISCATED", "DISABLED_SPECIAL", "EXCLUDED_INVALID_CLAIM_FIREHOSE", "EXPIRED_REASSIGNED", "FAILED_BACKORDER_CAPTURE", "FAILED_DROP_IMMEDIATE_THEN_ADD", "FAILED_PRE_REGISTRATION", "FAILED_REDEMPTION", "FAILED_REDEMPTION_REPORT", "FAILED_REGISTRATION", "FAILED_REGISTRATION_FIREHOSE", "FAILED_RESTORATION_REDEMPTION_MOCK", "FAILED_SETUP", "FAILED_TRANSFER_IN", "FAILED_TRANSFER_IN_BAD_STATUS", "FAILED_TRANSFER_IN_REGISTRY", "HELD_COURT_ORDERED", "HELD_DISPUTED", "HELD_EXPIRATION_PROTECTION", "HELD_EXPIRED_REDEMPTION_MOCK", "HELD_REGISTRAR_ADD", "HELD_REGISTRAR_REMOVE", "HELD_SHOPPER", "HELD_TEMPORARY", "LOCKED_ABUSE", "LOCKED_COPYRIGHT", "LOCKED_REGISTRY", "LOCKED_SUPER", "PARKED_AND_HELD", "PARKED_EXPIRED", "PARKED_VERIFICATION_ICANN", "PENDING_ABORT_CANCEL_SETUP", "PENDING_AGREEMENT_PRE_REGISTRATION", "PENDING_APPLY_RENEWAL_CREDITS", "PENDING_BACKORDER_CAPTURE", "PENDING_BLOCKED_REGISTRY", "PENDING_CANCEL_REGISTRANT_PROFILE", "PENDING_COMPLETE_REDEMPTION_WITHOUT_RECEIPT", "PENDING_COMPLETE_REGISTRANT_PROFILE", "PENDING_COO", "PENDING_COO_COMPLETE", "PENDING_DNS", "PENDING_DNS_ACTIVE", "PENDING_DNS_INACTIVE", "PENDING_DOCUMENT_VALIDATION", "PENDING_DOCUMENT_VERIFICATION", "PENDING_DROP_IMMEDIATE", "PENDING_DROP_IMMEDIATE_THEN_ADD", "PENDING_EPP_CREATE", "PENDING_EPP_DELETE", "PENDING_EPP_UPDATE", "PENDING_ESCALATION_REGISTRY", "PENDING_EXPIRATION", "PENDING_EXPIRATION_RESPONSE", "PENDING_EXPIRATION_SYNC", "PENDING_EXPIRED_REASSIGNMENT", "PENDING_EXPIRE_AUTO_ADD", "PENDING_EXTEND_REGISTRANT_PROFILE", "PENDING_FAILED_COO", "PENDING_FAILED_EPP_CREATE", "PENDING_FAILED_HELD", "PENDING_FAILED_PURCHASE_PREMIUM", "PENDING_FAILED_RECONCILE_FIREHOSE", "PENDING_FAILED_REDEMPTION_WITHOUT_RECEIPT", "PENDING_FAILED_RELEASE_PREMIUM", "PENDING_FAILED_RENEW_EXPIRATION_PROTECTION", "PENDING_FAILED_RESERVE_PREMIUM", "PENDING_FAILED_SUBMIT_FIREHOSE", "PENDING_FAILED_TRANSFER_ACK_PREMIUM", "PENDING_FAILED_TRANSFER_IN_ACK_PREMIUM", "PENDING_FAILED_TRANSFER_IN_PREMIUM", "PENDING_FAILED_TRANSFER_PREMIUM", "PENDING_FAILED_TRANSFER_SUBMIT_PREMIUM", "PENDING_FAILED_UNLOCK_PREMIUM", "PENDING_FAILED_UPDATE_API", "PENDING_FRAUD_VERIFICATION", "PENDING_FRAUD_VERIFIED", "PENDING_GET_CONTACTS", "PENDING_GET_HOSTS", "PENDING_GET_NAME_SERVERS", "PENDING_GET_STATUS", "PENDING_HOLD_ESCROW", "PENDING_HOLD_REDEMPTION", "PENDING_LOCK_CLIENT_REMOVE", "PENDING_LOCK_DATA_QUALITY", "PENDING_LOCK_THEN_HOLD_REDEMPTION", "PENDING_PARKING_DETERMINATION", "PENDING_PARK_INVALID_WHOIS", "PENDING_PARK_INVALID_WHOIS_REMOVAL", "PENDING_PURCHASE_PREMIUM", "PENDING_RECONCILE", "PENDING_RECONCILE_FIREHOSE", "PENDING_REDEMPTION", "PENDING_REDEMPTION_REPORT", "PENDING_REDEMPTION_REPORT_COMPLETE", "PENDING_REDEMPTION_REPORT_SUBMITTED", "PENDING_REDEMPTION_WITHOUT_RECEIPT", "PENDING_REDEMPTION_WITHOUT_RECEIPT_MOCK", "PENDING_RELEASE_PREMIUM", "PENDING_REMOVAL", "PENDING_REMOVAL_HELD", "PENDING_REMOVAL_PARKED", "PENDING_REMOVAL_UNPARK", "PENDING_RENEWAL", "PENDING_RENEW_EXPIRATION_PROTECTION", "PENDING_RENEW_INFINITE", "PENDING_RENEW_LOCKED", "PENDING_RENEW_WITHOUT_RECEIPT", "PENDING_REPORT_REDEMPTION_WITHOUT_RECEIPT", "PENDING_RESERVE_PREMIUM", "PENDING_RESET_VERIFICATION_ICANN", "PENDING_RESPONSE_FIREHOSE", "PENDING_RESTORATION", "PENDING_RESTORATION_INACTIVE", "PENDING_RESTORATION_REDEMPTION_MOCK", "PENDING_RETRY_EPP_CREATE", "PENDING_RETRY_HELD", "PENDING_SEND_AUTH_CODE", "PENDING_SETUP", "PENDING_SETUP_ABANDON", "PENDING_SETUP_AGREEMENT_LANDRUSH", "PENDING_SETUP_AGREEMENT_SUNRISE2_A", "PENDING_SETUP_AGREEMENT_SUNRISE2_B", "PENDING_SETUP_AGREEMENT_SUNRISE2_C", "PENDING_SETUP_AUTH", "PENDING_SETUP_DNS", "PENDING_SETUP_FAILED", "PENDING_SETUP_REVIEW", "PENDING_SETUP_SUNRISE", "PENDING_SETUP_SUNRISE_PRE", "PENDING_SETUP_SUNRISE_RESPONSE", "PENDING_SUBMIT_FAILURE", "PENDING_SUBMIT_FIREHOSE", "PENDING_SUBMIT_HOLD_FIREHOSE", "PENDING_SUBMIT_HOLD_LANDRUSH", "PENDING_SUBMIT_HOLD_SUNRISE", "PENDING_SUBMIT_LANDRUSH", "PENDING_SUBMIT_RESPONSE_FIREHOSE", "PENDING_SUBMIT_RESPONSE_LANDRUSH", "PENDING_SUBMIT_RESPONSE_SUNRISE", "PENDING_SUBMIT_SUCCESS_FIREHOSE", "PENDING_SUBMIT_SUCCESS_LANDRUSH", "PENDING_SUBMIT_SUCCESS_SUNRISE", "PENDING_SUBMIT_SUNRISE", "PENDING_SUBMIT_WAITING_LANDRUSH", "PENDING_SUCCESS_PRE_REGISTRATION", "PENDING_SUSPENDED_DATA_QUALITY", "PENDING_TRANSFER_ACK_PREMIUM", "PENDING_TRANSFER_IN", "PENDING_TRANSFER_IN_ACK", "PENDING_TRANSFER_IN_ACK_PREMIUM", "PENDING_TRANSFER_IN_BAD_REGISTRANT", "PENDING_TRANSFER_IN_CANCEL", "PENDING_TRANSFER_IN_CANCEL_REGISTRY", "PENDING_TRANSFER_IN_COMPLETE_ACK", "PENDING_TRANSFER_IN_DELETE", "PENDING_TRANSFER_IN_LOCK", "PENDING_TRANSFER_IN_NACK", "PENDING_TRANSFER_IN_NOTIFICATION", "PENDING_TRANSFER_IN_PREMIUM", "PENDING_TRANSFER_IN_RELEASE", "PENDING_TRANSFER_IN_RESPONSE", "PENDING_TRANSFER_IN_UNDERAGE", "PENDING_TRANSFER_OUT", "PENDING_TRANSFER_OUT_ACK", "PENDING_TRANSFER_OUT_NACK", "PENDING_TRANSFER_OUT_PREMIUM", "PENDING_TRANSFER_OUT_UNDERAGE", "PENDING_TRANSFER_OUT_VALIDATION", "PENDING_TRANSFER_PREMIUM", "PENDING_TRANSFER_PREMUIM", "PENDING_TRANSFER_SUBMIT_PREMIUM", "PENDING_UNLOCK_DATA_QUALITY", "PENDING_UNLOCK_PREMIUM", "PENDING_UPDATE", "PENDING_UPDATED_REGISTRANT_DATA_QUALITY", "PENDING_UPDATE_ACCOUNT", "PENDING_UPDATE_API", "PENDING_UPDATE_API_RESPONSE", "PENDING_UPDATE_AUTH", "PENDING_UPDATE_CONTACTS", "PENDING_UPDATE_CONTACTS_PRIVACY", "PENDING_UPDATE_DNS", "PENDING_UPDATE_DNS_SECURITY", "PENDING_UPDATE_ELIGIBILITY", "PENDING_UPDATE_EPP_CONTACTS", "PENDING_UPDATE_MEMBERSHIP", "PENDING_UPDATE_OWNERSHIP", "PENDING_UPDATE_OWNERSHIP_AUTH_AUCTION", "PENDING_UPDATE_OWNERSHIP_HELD", "PENDING_UPDATE_REGISTRANT", "PENDING_UPDATE_REPO", "PENDING_VALIDATION_DATA_QUALITY", "PENDING_VERIFICATION_FRAUD", "PENDING_VERIFICATION_STATUS", "PENDING_VERIFY_REGISTRANT_DATA_QUALITY", "RESERVED", "RESERVED_PREMIUM", "REVERTED", "SUSPENDED_VERIFICATION_ICANN", "TRANSFERRED_OUT", "UNLOCKED_ABUSE", "UNLOCKED_SUPER", "UNPARKED_AND_UNHELD", "UPDATED_OWNERSHIP", "UPDATED_OWNERSHIP_HELD" ], "type": "string" } } }, { "description": "Only include results with `status` value in any of the specified groups", "in": "query", "name": "statusGroups", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "INACTIVE", "PRE_REGISTRATION", "REDEMPTION", "RENEWABLE", "VERIFICATION_ICANN", "VISIBLE" ], "type": "string" } } }, { "description": "Maximum number of domains to return", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "description": "Marker Domain to use as the offset in results", "in": "query", "name": "marker", "required": false, "schema": { "type": "string" } }, { "description": "Optional details to be included in the response", "in": "query", "name": "includes", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "authCode", "contacts", "nameServers" ], "type": "string" } } }, { "description": "Only include results that have been modified since the specified date", "in": "query", "name": "modifiedDate", "required": false, "schema": { "type": "string", "format": "iso-datetime" } } ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DomainSummary" }, "type": "array" } }, "application/javascript": { "schema": { "items": { "$ref": "#/components/schemas/DomainSummary" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/DomainSummary" }, "type": "array" } }, "text/javascript": { "schema": { "items": { "$ref": "#/components/schemas/DomainSummary" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/DomainSummary" }, "type": "array" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Limit must have a value no greater than 1000", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "list", "summary": "Retrieve a list of Domains for the specified Shopper", "description": "Returns a paginated list of domains owned by the authenticated account. Supports filtering by status and optional inclusion of contacts, nameservers, and authCode in each record." } }, "/v1/domains/agreements": { "get": { "tags": [ "Register and Renew Domains" ], "parameters": [ { "description": "Unique identifier of the Market used to retrieve/translate Legal Agreements", "in": "header", "name": "X-Market-Id", "required": false, "schema": { "type": "string", "format": "bcp-47", "default": "en-US" } }, { "description": "list of TLDs whose legal agreements are to be retrieved", "in": "query", "name": "tlds", "required": true, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "Whether or not privacy has been requested", "in": "query", "name": "v1-privacy", "required": true, "schema": { "type": "boolean" } }, { "description": "Whether or not domain tranfer has been requested", "in": "query", "name": "forTransfer", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LegalAgreement" }, "type": "array" } }, "application/javascript": { "schema": { "items": { "$ref": "#/components/schemas/LegalAgreement" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/LegalAgreement" }, "type": "array" } }, "text/javascript": { "schema": { "items": { "$ref": "#/components/schemas/LegalAgreement" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/LegalAgreement" }, "type": "array" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "getAgreement", "summary": "Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons", "description": "Returns the TLD-specific legal agreements that must be accepted before purchase or transfer. The agreementKeys from this response are required in the consent object." } }, "/v1/domains/available": { "get": { "tags": [ "Find Domains" ], "parameters": [ { "description": "Domain name whose availability is to be checked", "in": "query", "name": "domain", "required": true, "schema": { "type": "string" } }, { "description": "Optimize for time ('FAST') or accuracy ('FULL')", "in": "query", "name": "checkType", "required": false, "schema": { "type": "string", "enum": [ "FAST", "FULL", "fast", "full" ], "default": "FAST" } }, { "description": "Whether or not to include domains available for transfer. If set to True, checkType is ignored", "in": "query", "name": "forTransfer", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvailableResponse" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainAvailableResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainAvailableResponse" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainAvailableResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainAvailableResponse" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- Cannot convert domain label error\n- Domain is missing IDN script\n- Domain segment ends with dash\n- Domain starts with dash\n- Domain uses unsupported IDN script\n- FQDN fails generic validity regex\n- Invalid character(s) error\n- Invalid tld error\n- Non-IDN domain name must not have dashes at the third and fourth position\n- Reserved name error\n- domain must be specified\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "available", "summary": "Determine whether or not the specified domain is available for purchase", "description": "Checks whether a single domain is available to register and returns the current price in currency-micro-unit format. The definitive flag indicates whether the result came from a live registry query." }, "post": { "tags": [ "Find Domains" ], "parameters": [ { "description": "Optimize for time ('FAST') or accuracy ('FULL')", "in": "query", "name": "checkType", "required": false, "schema": { "type": "string", "enum": [ "FAST", "FULL", "fast", "full" ], "default": "FAST" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "maximum": 500, "type": "array" } }, "application/xml": { "schema": { "items": { "type": "string" }, "maximum": 500, "type": "array" } }, "text/xml": { "schema": { "items": { "type": "string" }, "maximum": 500, "type": "array" } } }, "description": "Domain names for which to check availability", "required": true }, "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulk" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulk" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulk" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulk" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulk" } } } }, "203": { "description": "Request was partially successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulkMixed" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulkMixed" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulkMixed" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulkMixed" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainAvailableBulkMixed" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- Cannot convert domain label error\n- Domain is missing IDN script\n- Domain segment ends with dash\n- Domain starts with dash\n- Domain uses unsupported IDN script\n- FQDN fails generic validity regex\n- Invalid character(s) error\n- Invalid tld error\n- Non-IDN domain name must not have dashes at the third and fourth position\n- Reserved name error\n- domain must be specified\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "availableBulk", "summary": "Determine whether or not the specified domains are available for purchase", "description": "Checks availability for multiple domains in a single request. Returns an array of availability and pricing results, one per domain queried." } }, "/v1/domains/contacts/validate": { "post": { "tags": [ "Manage Domain Settings" ], "parameters": [ { "description": "MarketId in which the request is being made, and for which responses should be localized", "in": "query", "name": "marketId", "required": false, "schema": { "type": "string", "format": "bcp-47", "default": "en-US" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainsContactsBulk" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainsContactsBulk" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainsContactsBulk" } } }, "description": "An instance document expected for domains contacts validation", "required": true }, "responses": { "200": { "description": "No response was specified" }, "204": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Request body doesn't fulfill schema, see details in `fields`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDomainContactsValidate" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorDomainContactsValidate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorDomainContactsValidate" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorDomainContactsValidate" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorDomainContactsValidate" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "All contacts specified in request will be validated against all domains specified in \"domains\". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names", "operationId": "ContactsValidate", "summary": "Validate the request body using the Domain Contact Validation Schema for specified domains." } }, "/v1/domains/purchase": { "post": { "tags": [ "Register and Renew Domains" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DomainPurchase" }, "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- domain must be specified\n- Based on restrictions declared in JSON schema returned by `./schema/{tld}`\n- Cannot convert domain label error\n- Domain is missing IDN script\n- Domain segment ends with dash\n- Domain starts with dash\n- Domain uses unsupported IDN script\n- FQDN fails generic validity regex\n- Invalid character(s) error\n- Invalid tld error\n- Non-IDN domain name must not have dashes at the third and fourth position\n- Reserved name error\n- `body` must be specified\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "purchase", "summary": "Purchase and register the specified Domain", "description": "Registers the specified domain. Requires a consent object with agreement keys from GET /v1/domains/agreements. Charges the account's billing method." } }, "/v1/domains/purchase/schema/{tld}": { "get": { "tags": [ "Register and Renew Domains" ], "parameters": [ { "description": "The Top-Level Domain whose schema should be retrieved", "in": "path", "name": "tld", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonSchema" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/JsonSchema" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/JsonSchema" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/JsonSchema" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/JsonSchema" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`tld` must be specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "schema", "summary": "Retrieve the schema to be submitted when registering a Domain for the specified TLD", "description": "Returns the JSON schema for the domain purchase request body for the specified TLD. Fetch before purchasing to identify required fields and TLD-specific constraints." } }, "/v1/domains/purchase/validate": { "post": { "tags": [ "Register and Renew Domains" ], "requestBody": { "$ref": "#/components/requestBodies/DomainPurchase" }, "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Based on restrictions declared in JSON schema returned by `./schema/{tld}`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "validate", "summary": "Validate the request body using the Domain Purchase Schema for the specified TLD", "description": "Validates a purchase request body against the TLD schema with no side effects and no charge. Returns 200 on success." } }, "/v1/domains/suggest": { "get": { "tags": [ "Find Domains" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain name or set of keywords for which alternative domain names will be suggested", "in": "query", "name": "query", "required": false, "schema": { "type": "string" } }, { "description": "Two-letter ISO country code to be used as a hint for target region\nNOTE: These are sample values, there are many\nmore", "in": "query", "name": "country", "required": false, "schema": { "type": "string", "format": "iso-country-code", "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" ] } }, { "description": "Name of city to be used as a hint for target region", "in": "query", "name": "city", "required": false, "schema": { "type": "string", "format": "city-name" } }, { "description": "Sources to be queried\n- **CC_TLD** β€” Varies the TLD using Country Codes\n- **EXTENSION** β€” Varies the TLD\n- **KEYWORD_SPIN** β€” Identifies keywords and then rotates each one\n- **PREMIUM** β€” Includes variations with premium prices", "in": "query", "name": "sources", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "CC_TLD", "EXTENSION", "KEYWORD_SPIN", "PREMIUM", "cctld", "extension", "keywordspin", "premium" ], "type": "string" } } }, { "description": "Top-level domains to be included in suggestions\nNOTE: These are sample values, there are many\nmore", "in": "query", "name": "tlds", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "Maximum length of second-level domain", "in": "query", "name": "lengthMax", "required": false, "schema": { "type": "integer" } }, { "description": "Minimum length of second-level domain", "in": "query", "name": "lengthMin", "required": false, "schema": { "type": "integer" } }, { "description": "Maximum number of suggestions to return", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "description": "Maximum amount of time, in milliseconds, to wait for responses\nIf elapses, return the results compiled up to that point", "in": "query", "name": "waitMs", "required": false, "schema": { "type": "integer", "format": "integer-positive", "default": 1000 } } ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DomainSuggestion" }, "type": "array" } }, "application/javascript": { "schema": { "items": { "$ref": "#/components/schemas/DomainSuggestion" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/DomainSuggestion" }, "type": "array" } }, "text/javascript": { "schema": { "items": { "$ref": "#/components/schemas/DomainSuggestion" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/DomainSuggestion" }, "type": "array" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`query` must be specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "suggest", "summary": "Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history", "description": "Returns domain name suggestions based on a seed domain, keywords, or purchase history. Useful for presenting alternatives when a desired domain is unavailable." } }, "/v1/domains/tlds": { "get": { "tags": [ "Register and Renew Domains" ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TldSummary" }, "type": "array" } }, "application/javascript": { "schema": { "items": { "$ref": "#/components/schemas/TldSummary" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/TldSummary" }, "type": "array" } }, "text/javascript": { "schema": { "items": { "$ref": "#/components/schemas/TldSummary" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/TldSummary" }, "type": "array" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "tlds", "summary": "Retrieves a list of TLDs supported and enabled for sale", "description": "Returns all TLDs currently available for registration, including pricing and any eligibility requirements." } }, "/v1/domains/{domain}": { "delete": { "tags": [ "Manage Domain Settings" ], "parameters": [ { "description": "Domain to cancel", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The domain does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- Unknown domain error\n- At least two apex (aka @) `nameServers` must be specified\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "cancel", "summary": "Cancel a purchased domain", "description": "Cancels a purchased domain and initiates a refund if within the cancellation window. This action is irreversible." }, "get": { "tags": [ "Manage Domain Settings" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain name whose details are to be retrieved", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainDetail" } } } }, "203": { "description": "Request was partially successful, see verifications.status for further detail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainDetail" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainDetail" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`domain` must be specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "get", "summary": "Retrieve details for the specified Domain", "description": "Returns the full DomainDetail object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp." }, "patch": { "tags": [ "Manage Domain Settings" ], "parameters": [ { "description": "Domain whose details are to be updated", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } }, { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainUpdate" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainUpdate" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainUpdate" } } }, "description": "Changes to apply to existing Domain", "required": true }, "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Specified Subaccount not owned by authenticated Shopper", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The given domain is not eligible to have its nameservers changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- At least two apex (aka @) `nameServers` must be specified\n- Failed to update nameservers\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "update", "summary": "Update details for the specified Domain", "description": "Updates one or more fields on the domain. Accepts a partial DomainUpdate body - only fields included are modified. Returns 204 No Content." } }, "/v1/domains/{domain}/contacts": { "patch": { "tags": [ "Manage Domain Settings" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose Contacts are to be updated.", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainContacts" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainContacts" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainContacts" } } }, "description": "Changes to apply to existing Contacts", "required": true }, "responses": { "200": { "description": "No response was specified" }, "204": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "- Domain not found\n- Identity document not found\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`domain` is not a valid Domain name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "updateContacts", "summary": "Update domain", "description": "Updates domain settings. Only fields included in the request body are modified. Returns 204 No Content." } }, "/v1/domains/{domain}/records": { "patch": { "tags": [ "Manage DNS" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose DNS Records are to be augmented", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfDNSRecord" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ArrayOfDNSRecord" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ArrayOfDNSRecord" } } }, "description": "DNS Records to add to whatever currently exists", "required": true }, "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`domain` is not a valid Domain name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "recordAdd", "summary": "Add the specified DNS Records to the specified Domain", "description": "Appends DNS records to the domain's zone without removing existing records. Existing records with the same type and name are preserved. Returns 204 No Content." }, "put": { "tags": [ "Manage DNS" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose DNS Records are to be replaced", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } } }, "description": "DNS Records to replace whatever currently exists", "required": true }, "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- `domain` is not a valid Domain name\n- `record` does not fulfill the schema\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "recordReplace", "summary": "Replace all DNS Records for the specified Domain", "description": "Replaces the entire DNS record set for the domain. All existing records are removed and replaced with the submitted set. Returns 204 No Content." } }, "/v1/domains/{domain}/records/{type}/{name}": { "get": { "tags": [ "Manage DNS" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose DNS Records are to be retrieved", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } }, { "description": "DNS Record Type for which DNS Records are to be retrieved", "in": "path", "name": "type", "required": true, "schema": { "type": "string", "enum": [ "A", "AAAA", "CAA", "CNAME", "MX", "NS", "SOA", "SRV", "TXT" ] } }, { "description": "DNS Record Name for which DNS Records are to be retrieved", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Number of results to skip for pagination", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "Maximum number of items to return", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } }, "application/javascript": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } }, "text/javascript": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecord" }, "type": "array" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- `record` does not fulfill the schema\n- `domain` is not a valid Domain name\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "recordGet", "summary": "Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name", "description": "Returns DNS records for the domain. Optionally filter by record type and name. Returns an array of DNSRecord objects." }, "put": { "tags": [ "Manage DNS" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose DNS Records are to be replaced", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } }, { "description": "DNS Record Type for which DNS Records are to be replaced", "in": "path", "name": "type", "required": true, "schema": { "type": "string", "enum": [ "A", "AAAA", "CAA", "CNAME", "MX", "NS", "SOA", "SRV", "TXT" ] } }, { "description": "DNS Record Name for which DNS Records are to be replaced", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecordCreateTypeName" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecordCreateTypeName" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecordCreateTypeName" }, "type": "array" } } }, "description": "DNS Records to replace whatever currently exists", "required": true }, "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`record` does not fulfill the schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "recordReplaceTypeName", "summary": "Replace all DNS Records for the specified Domain with the specified Type and Name", "description": "Replaces all DNS records of the specified type and name. All other records are preserved. Returns 204 No Content." }, "delete": { "tags": [ "Manage DNS" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose DNS Records are to be deleted", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } }, { "description": "DNS Record Type for which DNS Records are to be deleted", "in": "path", "name": "type", "required": true, "schema": { "type": "string", "enum": [ "A", "AAAA", "CAA", "CNAME", "MX", "SRV", "TXT" ] } }, { "description": "DNS Record Name for which DNS Records are to be deleted", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Domain not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The given domain is not eligible to have its records changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`domain` is not a valid Domain name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "recordDeleteTypeName", "summary": "Delete all DNS Records for the specified Domain with the specified Type and Name", "description": "Deletes all DNS records matching the specified type and name. All other records are preserved. Returns 204 No Content." } }, "/v1/domains/{domain}/records/{type}": { "put": { "tags": [ "Manage DNS" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose DNS Records are to be replaced", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } }, { "description": "DNS Record Type for which DNS Records are to be replaced", "in": "path", "name": "type", "required": true, "schema": { "type": "string", "enum": [ "A", "AAAA", "CAA", "CNAME", "MX", "NS", "SOA", "SRV", "TXT" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecordCreateType" }, "type": "array" } }, "application/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecordCreateType" }, "type": "array" } }, "text/xml": { "schema": { "items": { "$ref": "#/components/schemas/DNSRecordCreateType" }, "type": "array" } } }, "description": "DNS Records to replace whatever currently exists", "required": true }, "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`record` does not fulfill the schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "recordReplaceType", "summary": "Replace all DNS Records for the specified Domain with the specified Type", "description": "Replaces all DNS records of the specified type across all names. Records of other types are preserved. Returns 204 No Content." } }, "/v1/domains/{domain}/renew": { "post": { "tags": [ "Register and Renew Domains" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain to renew", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainRenew" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainRenew" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainRenew" } } }, "description": "Options for renewing existing Domain" }, "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The domain status does not allow performing the operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- End-user must read and consent to all of the following legal agreements\n- `domain` must match `sld.tld`\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "renew", "summary": "Renew the specified Domain", "description": "Renews the domain for the specified period, extending the expiration date. Charges the account's billing method." } }, "/v1/domains/{domain}/transfer": { "post": { "tags": [ "Transfer Domains" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain to transfer in", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainTransferIn" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainTransferIn" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainTransferIn" } } }, "description": "Details for domain transfer purchase", "required": true }, "responses": { "200": { "description": "Request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchaseResponse" } } } }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`domain` (domain) isn't available for transfer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "- Based on restrictions declared in JSON schema returned by `./schema/{tld}`\n- Cannot convert domain label error\n- Domain is missing IDN script\n- Domain segment ends with dash\n- Domain starts with dash\n- Domain uses unsupported IDN script\n- End-user must read and consent to all of the following legal agreements\n- FQDN fails generic validity regex\n- Invalid character(s) error\n- Invalid period range\n- Invalid tld error\n- Non-IDN domain name must not have dashes at the third and fourth position\n- Reserved name error\n- `authCode` cannot be empty\n- `domain` must match `sld.tld`\n- domain must be specified\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "transferIn", "summary": "Purchase and start or restart transfer process", "description": "Initiates an inbound domain transfer from another registrar. Requires an authcode and a consent object with agreement keys. Charges a transfer fee." } }, "/v1/domains/{domain}/verifyRegistrantEmail": { "post": { "tags": [ "Manage Domain Settings" ], "parameters": [ { "description": "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.", "in": "header", "name": "X-Shopper-Id", "required": false, "schema": { "type": "string" } }, { "description": "Domain whose Contact E-mail should be verified.", "in": "path", "name": "domain", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request was successful" }, "400": { "description": "Request was malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication info not sent or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Authenticated user is not allowed access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "`domain` is not a valid Domain name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests received within interval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ErrorLimit" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/javascript": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "verifyEmail", "summary": "Re-send Contact E-mail Verification for specified Domain", "description": "Re-sends the ICANN registrant email verification to the domain's registrant contact. Use when the original verification email was not received or has expired." } } }, "components": { "requestBodies": { "DomainPurchase": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainPurchase" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchase" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DomainPurchase" } } }, "description": "An instance document expected to match the JSON schema returned by `./schema/{tld}`", "required": true }, "DomainTransferInV2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainTransferInV2" } } }, "description": "Details for domain transfer purchase", "required": true }, "DomainTransferAuthCode": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainTransferAuthCode" } } }, "description": "An Authorization code for transferring the Domain", "required": true }, "DomainPurchaseV2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainPurchaseV2" } } }, "description": "An instance document expected to match the JSON schema returned by `./schema/{tld}`", "required": true } }, "schemas": { "Action": { "properties": { "type": { "type": "string", "description": "The type of action being performed:\n\n- **AUTH_CODE_PURCHASE** β€” Request for an auth code for a .de domain via POST /v2/customers/{customerId}/domains/{domain}/purchaseAuthCode.\n- **AUTH_CODE_REGENERATE** β€” Request to regenerate the authCode for a domain via POST /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode\n- **AUTO_RENEWAL** β€” A Domain Auto Renew is in progress.\n- **BACKORDER_PURCHASE** β€” Request to purchase a domain backorder via POST /v2/customers/{customerId}/domains/backorders/purchase.\n- **BACKORDER_DELETE** β€” Request to cancel the current domain backorder via DELETE /v2/customers/{customerId}/domains/backorders/{domain}.\n- **BACKORDER_UPDATE** β€” Request update the current domain backorder via PATCH /v2/customers/{customerId}/domains/backorders/{domain}.\n- **CHANGE_OF_REGISTRANT_DELETE** β€” Request to delete a change of registrant request via DELETE /v2/customers/{customerId}/domains/{domain}/changeOfRegistrant.\n- **CONTACT_CREATE** β€” Request to create a contact via POST /v2/customers/{customerId}/domains/contacts.\n- **CONTACT_DELETE** β€” Request to delete a contact via DELETE /v2/customers/{customerId}/domains/contacts/{contactId}\n- **CONTACT_UPDATE** β€” Request to update a contact via PATCH /v2/customers/{customerId}/domains/contacts/{contactId}\n- **DNS_VERIFICATION** β€” Domain requires zone file setup.\n- **DNSSEC_CREATE** β€” Request to create DNSSEC record for the domain via PATCH /v2/customers/{customerId}/domains/{domain}/dnssecRecords.\n- **DNSSEC_DELETE** β€” Request to delete DNSSEC record for the domain via DELETE /v2/customers/{customerId}/domains/{domain}/dnssecRecords.\n- **DOMAIN_DELETE** β€” Request to delete the domain via DELETE /v2/customers/{customerId}/domains/{domain}\n- **DOMAIN_UPDATE** β€” Request to update the domain via PATCH /v2/customers/{customerId}/domains/{domain}\n- **DOMAIN_UPDATE_CONTACTS** β€” Request to update the domain contacts via PATCH /v2/customers/{customerId}/domains/{domain}/contacts\n- **DOMAIN_UPDATE_NAME_SERVERS** β€” Request to update the domain name servers via PUT /v2/customers/{customerId}/domains/{domain}/nameServers\n- **EXPIRY** β€” A Domain Expiration is in progress.\n- **HOST_CREATE** β€” Request to create a hostname via PUT /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}\n- **HOST_DELETE** β€” Request to delete a hostname via DELETE /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}\n- **ICANN_VERIFICATION** β€” Domain requires registrant verification for Icann.\n- **PREMIUM** β€” Premium Domain domain sale is in progress.\n- **PRIVACY_FORWARDING_UPDATE** β€” Request to update privacy forwarding information via PATCH /v2/customers/{customerId}/domains/{domain}/privacy/forwarding.\n- **PRIVACY_PURCHASE** β€” Request to purchase privacy for a domain via POST /v2/customers/{customerId}/domains/{domain}/privacy/purchase\n- **PRIVACY_DELETE** β€” Request to remove privacy from a domain via DELETE /v2/customers/{customerId}/domains/{domain}/privacy\n- **REDEEM** β€” Request to redeem a domain via POST /v2/customers/{customerId}/domains/{domain}/redeem\n- **REGISTER** β€” Request to register a domain via POST /v2/customers/{customerId}/domains/{domain}/register\n- **RENEW** β€” Request to renew a domain via POST /v2/customers/{customerId}/domains/{domain}/renew\n- **RENEW_UNDO** β€” Request to undo a renewal for a uk domain via POST /v2/customers/{customerId}/domains/{domain}/undoRenew\n- **TRADE** β€” A domain trade request is in progress\n- **TRADE_CANCEL** β€” Request to cancel a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeCancel\n- **TRADE_PURCHASE** β€” Request to purchase a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchase\n- **TRADE_PURCHASE_AUTH_TEXT_MESSAGE** β€” Request for a trade purchase text message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchaseAuthorizationTextMessage\n- **TRADE_RESEND_AUTH_EMAIL** β€” Request to resend the trade auth email message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeResendAuthorizationEmail\n- **TRANSFER** β€” Request to transfer a domain via POST /v2/customers/{customerId}/domains/{domain}/transfer\n- **TRANSFER_IN** β€” A domain transfer in request is in progress.\n- **TRANSFER_IN_ACCEPT** β€” Request to accept a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInAccept\n- **TRANSFER_IN_CANCEL** β€” Request to cancel a domain transfer via POST /v2/customers/{customerId}/domains/{domain}/transferInCancel\n- **TRANSFER_IN_RESTART** β€” Request to restart a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRestart\n- **TRANSFER_IN_RETRY** β€” Request to retry a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRetry\n- **TRANSFER_OUT** β€” A domain transfer out request is in progress.\n- **TRANSFER_OUT_ACCEPT** β€” Request to accept a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutAccept\n- **TRANSFER_OUT_REJECT** β€” Request to reject a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutReject\n- **TRANSFER_OUT_REQUESTED** β€” Request to transfer out for a domain (.de) via POST /v2/customers/{customerId}/domains/{domain}/transferOut\n- **TRANSIT** β€” Request to transit a de or at domain at the registry via POST /v2/customers/{customerId}/domains/{domain}/transit", "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": { "type": "string", "enum": [ "USER", "SYSTEM" ], "description": "The origination of the action:\n\n- **USER** β€” These are user requests.\n- **SYSTEM** β€” These are system processing actions." }, "createdAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the action was created" }, "startedAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the action was started" }, "completedAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the action was completed" }, "modifiedAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the action was last modified" }, "status": { "type": "string", "default": "ACCEPTED", "enum": [ "ACCEPTED", "AWAITING", "CANCELLED", "FAILED", "PENDING", "SUCCESS" ], "description": "The current status of the action:\n\n- **ACCEPTED** β€” The action has been queued, processing has not started.\n- **AWAITING** β€” The action is waiting on a user input.\n- **CANCELLED** β€” The action has been cancelled by the user.\n- **FAILED** β€” An error occurred while the action was processing, no more processing will be performed.\n- **PENDING** β€” The action is being processed.\n- **SUCCESS** β€” The action has completed, no additional processing is required." }, "reason": { "$ref": "#/components/schemas/ActionReason" }, "requestId": { "type": "string", "description": "A client provided identifier (via X-Request-Id header) used for tracking individual requests" } }, "required": [ "type", "origination", "createdAt", "status" ], "type": "object" }, "ActionReason": { "additionalProperties": false, "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" }, "message": { "type": "string", "description": "Human-readable, English description of the code" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorField" }, "description": "List of the specific fields, and the errors found with their contents" } }, "required": [ "code" ], "type": "object" }, "Address": { "properties": { "address1": { "format": "street-address", "type": "string" }, "address2": { "format": "street-address2", "type": "string" }, "city": { "format": "city-name", "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region\nNOTE: These are sample values, there are many\nmore", "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" ], "format": "iso-country-code", "type": "string" }, "postalCode": { "description": "Postal or zip code", "format": "postal-code", "type": "string" }, "state": { "description": "State or province or territory", "format": "state-province-territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ], "type": "object" }, "ArrayOfDNSRecord": { "type": "array", "items": { "$ref": "#/components/schemas/DNSRecord" } }, "Consent": { "properties": { "agreedAt": { "description": "Timestamp indicating when the end-user consented to these legal agreements", "format": "iso-datetime", "type": "string" }, "agreedBy": { "description": "Originating client IP address of the end-user's computer when they consented to these legal agreements", "type": "string" }, "agreementKeys": { "description": "Unique identifiers of the legal agreements to which the end-user has agreed, as returned from the/domains/agreements endpoint", "items": { "type": "string" }, "type": "array" } }, "required": [ "agreementKeys", "agreedBy", "agreedAt" ], "type": "object" }, "ConsentV2": { "additionalProperties": false, "properties": { "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" }, "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" }, "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" }, "agreedBy": { "type": "string", "description": "Originating client IP address of the end-user's computer when they consented to these legal agreements" }, "agreedAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the end-user consented to these legal agreements" }, "claimToken": { "description": "The trademark claim token, only needed if the domain has an active trademark claim", "type": "string" } }, "required": [ "agreementKeys", "price", "currency", "agreedBy", "agreedAt" ], "type": "object" }, "ConsentRedemption": { "additionalProperties": false, "properties": { "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" }, "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" }, "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" }, "agreedBy": { "type": "string", "description": "Originating client IP address of the end-user's computer when they consented to these legal agreements" }, "agreedAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the end-user consented to these legal agreements" } }, "required": [ "price", "fee", "currency", "agreedBy", "agreedAt" ], "type": "object" }, "ConsentRenew": { "additionalProperties": false, "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" }, "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" }, "agreedBy": { "type": "string", "description": "Originating client IP address of the end-user's computer when they consented to these legal agreements" }, "agreedAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the end-user consented to these legal agreements" } }, "required": [ "price", "currency", "agreedBy", "agreedAt" ], "type": "object" }, "ConsentDomainUpdate": { "properties": { "agreedAt": { "description": "Timestamp indicating when the end-user consented to these agreements", "format": "iso-datetime", "type": "string" }, "agreedBy": { "description": "Originating client IP address of the end-user's computer when they consented to the agreements", "type": "string" }, "agreementKeys": { "description": "Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated:\n\n- **EXPOSE_REGISTRANT_ORGANIZATION** β€” Required when the exposeRegistrantOrganization field is updated to true\n- **EXPOSE_WHOIS** β€” Required when the exposeWhois field is updated to true", "items": { "enum": [ "EXPOSE_REGISTRANT_ORGANIZATION", "EXPOSE_WHOIS" ], "type": "string" }, "type": "array" } }, "required": [ "agreementKeys", "agreedBy", "agreedAt" ], "type": "object" }, "Contact": { "properties": { "addressMailing": { "$ref": "#/components/schemas/Address" }, "email": { "format": "email", "type": "string" }, "fax": { "format": "phone", "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "format": "person-name", "type": "string" }, "nameLast": { "format": "person-name", "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "format": "organization-name", "type": "string" }, "phone": { "format": "phone", "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ], "type": "object" }, "ContactDomain": { "properties": { "contactId": { "type": "string", "description": "Unique identifier for this Contact" }, "encoding": { "type": "string", "default": "ASCII", "enum": [ "ASCII", "UTF-8" ], "description": "The encoding of the contact data:\n\n- **ASCII** β€” Data contains only ASCII characters that are not region or language specific\n- **UTF-8** β€” Data contains characters that are specific to a region or language" }, "nameFirst": { "type": "string", "format": "person-name", "maxLength": 30 }, "nameMiddle": { "type": "string" }, "nameLast": { "type": "string", "format": "person-name", "maxLength": 30 }, "organization": { "type": "string", "format": "organization-name", "maxLength": 100 }, "jobTitle": { "type": "string" }, "email": { "type": "string", "format": "email", "maxLength": 80 }, "phone": { "type": "string", "format": "phone", "maxLength": 17 }, "fax": { "type": "string", "format": "phone", "maxLength": 17 }, "addressMailing": { "$ref": "#/components/schemas/Address" }, "exposeRegistrantOrganization": { "type": "boolean", "description": "Whether or not the domain registrant contact organization field should be shown in the WHOIS" }, "exposeWhois": { "type": "boolean", "description": "Whether or not the contact details should be shown in the WHOIS" }, "metadata": { "type": "object", "description": "The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld}" }, "tlds": { "type": "array", "description": "The tlds that this contact can be assigned to", "items": { "type": "string" } }, "_createdAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the contact was created" }, "_modifiedAt": { "type": "string", "format": "iso-datetime", "description": "Timestamp indicating when the contact was last modified" }, "_deleted": { "type": "boolean", "description": "Flag indicating if the contact has been logically deleted in the system" }, "_revision": { "type": "integer", "description": "The current revision number of the contact." } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing", "exposeWhois", "exposeRegistrantOrganization" ], "type": "object" }, "ContactDomainCreate": { "additionalProperties": false, "properties": { "encoding": { "type": "string", "default": "ASCII", "enum": [ "ASCII", "UTF-8" ], "description": "The encoding of the contact data:\n\n- **ASCII** β€” Data contains only ASCII characters that are not region or language specific\n- **UTF-8** β€” Data contains characters that are specific to a region or language" }, "nameFirst": { "type": "string", "format": "person-name", "maxLength": 30 }, "nameMiddle": { "type": "string" }, "nameLast": { "type": "string", "format": "person-name", "maxLength": 30 }, "organization": { "type": "string", "format": "organization-name", "maxLength": 100 }, "jobTitle": { "type": "string" }, "email": { "type": "string", "format": "email", "maxLength": 80 }, "phone": { "type": "string", "format": "phone", "maxLength": 17 }, "fax": { "type": "string", "format": "phone", "maxLength": 17 }, "addressMailing": { "$ref": "#/components/schemas/Address" }, "metadata": { "type": "object", "description": "The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld}" } }, "required": [ "encoding", "nameFirst", "nameLast", "email", "phone", "addressMailing" ], "type": "object" }, "ContactRegistrantChange": { "properties": { "email": { "type": "string", "format": "email", "maxLength": 80 }, "firstName": { "type": "string", "format": "person-name", "maxLength": 30 }, "lastName": { "type": "string", "format": "person-name", "maxLength": 30 }, "organization": { "type": "string", "format": "organization-name", "maxLength": 100 } }, "required": [ "email", "firstName", "lastName" ], "type": "object" }, "DNSRecord": { "properties": { "data": { "type": "string" }, "name": { "format": "domain", "type": "string" }, "port": { "description": "Service port (SRV only)", "maximum": 65535, "minimum": 1, "type": "integer" }, "priority": { "description": "Record priority (MX and SRV only)", "format": "integer-positive", "type": "integer" }, "protocol": { "description": "Service protocol (SRV only)", "type": "string" }, "service": { "description": "Service type (SRV only)", "type": "string" }, "ttl": { "format": "integer-positive", "type": "integer" }, "type": { "enum": [ "A", "AAAA", "CAA", "CNAME", "MX", "NS", "SOA", "SRV", "TXT" ], "type": "string" }, "weight": { "description": "Record weight (SRV only)", "format": "integer-positive", "type": "integer" } }, "required": [ "type", "name", "data" ], "type": "object" }, "DNSRecordCreateType": { "properties": { "data": { "type": "string" }, "name": { "format": "domain", "type": "string" }, "port": { "description": "Service port (SRV only)", "maximum": 65535, "minimum": 1, "type": "integer" }, "priority": { "description": "Record priority (MX and SRV only)", "format": "integer-positive", "type": "integer" }, "protocol": { "description": "Service protocol (SRV only)", "type": "string" }, "service": { "description": "Service type (SRV only)", "type": "string" }, "ttl": { "format": "integer-positive", "type": "integer" }, "weight": { "description": "Record weight (SRV only)", "format": "integer-positive", "type": "integer" } }, "required": [ "name", "data" ], "type": "object" }, "DNSRecordCreateTypeName": { "properties": { "data": { "type": "string" }, "port": { "description": "Service port (SRV only)", "maximum": 65535, "minimum": 1, "type": "integer" }, "priority": { "description": "Record priority (MX and SRV only)", "format": "integer-positive", "type": "integer" }, "protocol": { "description": "Service protocol (SRV only)", "type": "string" }, "service": { "description": "Service type (SRV only)", "type": "string" }, "ttl": { "format": "integer-positive", "type": "integer" }, "weight": { "description": "Record weight (SRV only)", "format": "integer-positive", "type": "integer" } }, "required": [ "data" ], "type": "object" }, "DomainAvailableBulk": { "properties": { "domains": { "description": "Domain available response array", "items": { "$ref": "#/components/schemas/DomainAvailableResponse" }, "type": "array" } }, "required": [ "domains" ], "type": "object" }, "DomainAvailableBulkMixed": { "properties": { "domains": { "description": "Domain available response array", "items": { "$ref": "#/components/schemas/DomainAvailableResponse" }, "type": "array" }, "errors": { "description": "Errors encountered while performing a domain available check", "items": { "$ref": "#/components/schemas/DomainAvailableError" }, "type": "array" } }, "required": [ "domains" ], "type": "object" }, "DomainAvailableError": { "properties": { "code": { "description": "Short identifier for the error, suitable for indicating the specific error within client code", "format": "constant", "type": "string" }, "domain": { "description": "Domain name", "type": "string" }, "message": { "description": "Human-readable, English description of the error", "type": "string" }, "path": { "description": "- JSONPath referring to a field containing an error\n**OR**\n- JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`", "format": "json-path", "type": "string" }, "status": { "description": "HTTP status code that would return for a single check", "type": "integer" } }, "required": [ "code", "domain", "path", "status" ], "type": "object" }, "DomainAvailableResponse": { "properties": { "available": { "description": "Whether or not the domain name is available", "type": "boolean" }, "currency": { "default": "USD", "description": "Currency in which the `price` is listed. Only returned if tld is offered", "format": "iso-currency-code", "type": "string" }, "definitive": { "description": "Whether or not the `available` answer has been definitively verified with the registry", "type": "boolean" }, "domain": { "description": "Domain name", "type": "string" }, "period": { "description": "Number of years included in the price. Only returned if tld is offered", "format": "integer-positive", "type": "integer" }, "price": { "description": "Price of the domain excluding taxes or fees. Only returned if tld is offered", "format": "currency-micro-unit", "type": "integer" } }, "required": [ "domain", "available", "definitive" ], "type": "object" }, "DomainChangeOfRegistrant": { "properties": { "createDate": { "type": "string", "format": "iso-datetime" }, "gainingContact": { "$ref": "#/components/schemas/ContactRegistrantChange" }, "losingContact": { "$ref": "#/components/schemas/ContactRegistrantChange" }, "otherDomainsAffected": { "type": "integer", "format": "integer-positive" }, "shopperEmail": { "type": "string", "format": "email" } }, "required": [ "createDate", "gainingContact", "losingContact" ], "type": "object" }, "DomainContacts": { "properties": { "contactAdmin": { "$ref": "#/components/schemas/Contact" }, "contactBilling": { "$ref": "#/components/schemas/Contact" }, "contactRegistrant": { "$ref": "#/components/schemas/Contact" }, "contactTech": { "$ref": "#/components/schemas/Contact" } }, "required": [ "contactRegistrant" ], "type": "object" }, "DomainContactsCreateV2": { "additionalProperties": false, "type": "object", "properties": { "admin": { "$ref": "#/components/schemas/ContactDomainCreate" }, "adminId": { "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", "type": "string" }, "billing": { "$ref": "#/components/schemas/ContactDomainCreate" }, "billingId": { "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", "type": "string" }, "registrant": { "$ref": "#/components/schemas/ContactDomainCreate" }, "registrantId": { "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", "type": "string" }, "tech": { "$ref": "#/components/schemas/ContactDomainCreate" }, "techId": { "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", "type": "string" } } }, "DomainContactsUpdateV2": { "additionalProperties": false, "properties": { "identityDocumentId": { "type": "string", "description": "Unique identifier of the identify document that the user wants to associate with the domain whose registrant contact is being updated. This is required only if user is trying to update registrant contact and the owning registry has a requirement for an approved identity document" }, "contacts": { "$ref": "#/components/schemas/DomainContactsCreateV2" } }, "type": "object" }, "DomainContactsV2": { "additionalProperties": false, "properties": { "registrant": { "$ref": "#/components/schemas/ContactDomain" }, "admin": { "$ref": "#/components/schemas/ContactDomain" }, "tech": { "$ref": "#/components/schemas/ContactDomain" }, "billing": { "$ref": "#/components/schemas/ContactDomain" } }, "type": "object" }, "DomainDetail": { "properties": { "authCode": { "description": "Authorization code for transferring the Domain", "type": "string" }, "contactAdmin": { "$ref": "#/components/schemas/Contact" }, "contactBilling": { "$ref": "#/components/schemas/Contact" }, "contactRegistrant": { "$ref": "#/components/schemas/Contact" }, "contactTech": { "$ref": "#/components/schemas/Contact" }, "createdAt": { "description": "Date and time when this domain was created", "format": "date-time", "type": "string" }, "deletedAt": { "description": "Date and time when this domain was deleted", "format": "date-time", "type": "string" }, "transferAwayEligibleAt": { "description": "Date and time when this domain is eligible to transfer", "format": "date-time", "type": "string" }, "domain": { "description": "Name of the domain", "type": "string" }, "domainId": { "description": "Unique identifier for this Domain", "format": "double", "type": "number" }, "expirationProtected": { "description": "Whether or not the domain is protected from expiration", "type": "boolean" }, "expires": { "description": "Date and time when this domain will expire", "format": "date-time", "type": "string" }, "exposeRegistrantOrganization": { "type": "boolean", "description": "Whether or not the domain registrant contact organization field should be shown in the WHOIS" }, "exposeWhois": { "description": "Whether or not the domain contact details should be shown in the WHOIS", "type": "boolean" }, "holdRegistrar": { "description": "Whether or not the domain is on-hold by the registrar", "type": "boolean" }, "locked": { "description": "Whether or not the domain is locked to prevent transfers", "type": "boolean" }, "nameServers": { "description": "Fully-qualified domain names for DNS servers", "items": { "format": "host-name", "type": "string" }, "type": "array" }, "privacy": { "description": "Whether or not the domain has privacy protection", "type": "boolean" }, "registrarCreatedAt": { "type": "string", "format": "iso-datetime", "description": "Date and time when this domain was created by the registrar" }, "renewAuto": { "description": "Whether or not the domain is configured to automatically renew", "type": "boolean" }, "renewDeadline": { "description": "Date the domain must renew on", "format": "date-time", "type": "string" }, "status": { "description": "Processing status of the domain\n- **ACTIVE** β€” All is well\n- **AWAITING*** β€” System is waiting for the end-user to complete an action\n- **CANCELLED*** β€” Domain has been cancelled, and may or may not be reclaimable\n- **CONFISCATED** β€” Domain has been confiscated, usually for abuse, chargeback, or fraud\n- **DISABLED*** β€” Domain has been disabled\n- **EXCLUDED*** β€” Domain has been excluded from Firehose registration\n- **EXPIRED*** β€” Domain has expired\n- **FAILED*** β€” Domain has failed a required action, and the system is no longer retrying\n- **HELD*** β€” Domain has been placed on hold, and likely requires intervention from Support\n- **LOCKED*** β€” Domain has been locked, and likely requires intervention from Support\n- **PARKED*** β€” Domain has been parked, and likely requires intervention from Support\n- **PENDING*** β€” Domain is working its way through an automated workflow\n- **RESERVED*** β€” Domain is reserved, and likely requires intervention from Support\n- **REVERTED** β€” Domain has been reverted, and likely requires intervention from Support\n- **SUSPENDED*** β€” Domain has been suspended, and likely requires intervention from Support\n- **TRANSFERRED*** β€” Domain has been transferred out\n- **UNKNOWN** β€” Domain is in an unknown state\n- **UNLOCKED*** β€” Domain has been unlocked, and likely requires intervention from Support\n- **UNPARKED*** β€” Domain has been unparked, and likely requires intervention from Support\n- **UPDATED*** β€” Domain ownership has been transferred to another account", "type": "string" }, "subaccountId": { "description": "Reseller subaccount shopperid who can manage the domain", "type": "string" }, "transferProtected": { "description": "Whether or not the domain is protected from transfer", "type": "boolean" }, "verifications": { "$ref": "#/components/schemas/VerificationsDomain" } }, "required": [ "domainId", "domain", "status", "expirationProtected", "holdRegistrar", "locked", "v1-privacy", "renewAuto", "renewDeadline", "v1-transferProtected", "createdAt", "authCode", "nameServers", "contactRegistrant", "contactBilling", "contactAdmin", "contactTech" ], "type": "object" }, "DomainDetailV2": { "additionalProperties": false, "properties": { "domainId": { "type": "string", "description": "Unique identifier for this Domain" }, "domain": { "type": "string", "description": "Name of the domain", "format": "domain" }, "subaccountId": { "type": "string", "description": "Reseller subaccount shopperid who can manage the domain" }, "status": { "type": "string", "description": "The current status of the domain:\n\n- **ACTIVE** β€” Domain has been registered and is active.\n- **CANCELLED** β€” Domain has been cancelled by the user or system, and is not reclaimable.\n- **DELETED_REDEEMABLE** β€” Domain is deleted but is redeemable.\n- **EXPIRED** β€” Domain has expired.\n- **FAILED** β€” Domain registration or transfer error.\n- **LOCKED_REGISTRAR** β€” Domain is locked at the registrar (this is usually the result of a spam, abuse, etc.).\n- **PARKED** β€” Domain has been parked.\n- **HELD_REGISTRAR** β€” Domain is held at the registrar and cannot be transferred or modified - this is usually the result of a dispute.\n- **OWNERSHIP_CHANGED** β€” Domain has been moved to another account.\n- **PENDING_TRANSFER** β€” Domain transfer has been requested and is pending the transfer process.\n- **PENDING_REGISTRATION** β€” Domain is pending setup at the registry.\n- **REPOSSESSED** β€” Domain has been confiscated (this is usually the result of a chargeback, fraud, abuse, etc.).\n- **SUSPENDED** β€” Domain is in violation and has been suspended.\n- **TRANSFERRED** β€” Domain has been transferred to another registrar.", "enum": [ "ACTIVE", "CANCELLED", "DELETED_REDEEMABLE", "EXPIRED", "FAILED", "LOCKED_REGISTRAR", "PARKED", "HELD_REGISTRAR", "OWNERSHIP_CHANGED", "PENDING_TRANSFER", "PENDING_REGISTRATION", "REPOSSESSED", "SUSPENDED", "TRANSFERRED" ] }, "expiresAt": { "type": "string", "format": "iso-datetime", "description": "Date and time when this domain will expire" }, "expirationProtected": { "type": "boolean", "description": "Whether or not the domain is protected from expiration" }, "holdRegistrar": { "type": "boolean", "description": "Whether or not the domain is on-hold by the registrar" }, "locked": { "type": "boolean", "description": "Whether or not the domain is locked to prevent transfers" }, "privacy": { "type": "boolean", "description": "Whether or not the domain has privacy protection" }, "registrarCreatedAt": { "type": "string", "format": "iso-datetime", "description": "Date and time when this domain was created by the registrar" }, "renewAuto": { "type": "boolean", "description": "Whether or not the domain is configured to automatically renew" }, "renewDeadline": { "type": "string", "format": "iso-datetime", "description": "Date the domain must renew on" }, "transferProtected": { "type": "boolean", "description": "Whether or not the domain is protected from transfer" }, "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" }, "modifiedAt": { "type": "string", "format": "iso-datetime", "description": "Date and time when this domain was last modified" }, "transferAwayEligibleAt": { "type": "string", "format": "iso-datetime", "description": "Date and time when this domain is eligible to transfer" }, "authCode": { "type": "string", "description": "Authorization code for transferring the Domain" }, "nameServers": { "type": "array", "items": { "type": "string", "format": "host-name" }, "description": "Fully-qualified domain names for DNS servers" }, "hostnames": { "type": "array", "items": { "type": "string", "format": "host-name" }, "description": "Hostnames owned by the domain" }, "renewal": { "$ref": "#/components/schemas/RenewalDetails" }, "verifications": { "$ref": "#/components/schemas/VerificationsDomainV2" }, "contacts": { "$ref": "#/components/schemas/DomainContactsV2" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Action" }, "description": "List of current actions in progress for this domain" }, "dnssecRecords": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDnssec" }, "description": "List of active DNSSEC records for this domain" }, "registryStatusCodes": { "type": "array", "items": { "type": "string", "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" ] }, "description": "The current registry status codes of the domain:\n\n- **ADD_PERIOD** β€” This grace period is provided after the initial registration of a domain name.\n- **AUTO_RENEW_PERIOD** β€” This grace period is provided after a domain name registration period expires and is extended (renewed) automatically by the registry.\n- **CLIENT_DELETE_PROHIBITED** β€” This status code tells your domain's registry to reject requests to delete the domain.\n- **CLIENT_HOLD** β€” This status code tells your domain's registry to not activate your domain in the DNS and as a consequence, it will not resolve.\n- **CLIENT_RENEW_PROHIBITED** β€” This status code tells your domain's registry to reject requests to renew your domain.\n- **CLIENT_TRANSFER_PROHIBITED** β€” This status code tells your domain's registry to reject requests to transfer the domain from your current registrar to another.\n- **CLIENT_UPDATE_PROHIBITED** β€” This status code tells your domain's registry to reject requests to update the domain.\n- **INACTIVE** β€” This status code indicates that delegation information (name servers) has not been associated with your domain.\n- **OK** β€” This is the standard status for a domain, meaning it has no pending operations or prohibitions.\n- **PENDING_CREATE** β€” This status code indicates that a request to create your domain has been received and is being processed.\n- **PENDING_DELETE** β€” 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.\n- **PENDING_RENEW** β€” This status code indicates that a request to renew your domain has been received and is being processed.\n- **PENDING_RESTORE** β€” This status code indicates that your registrar has asked the registry to restore your domain that was in REDEMPTION_PERIOD status\n- **PENDING_TRANSFER** β€” This status code indicates that a request to transfer your domain to a new registrar has been received and is being processed.\n- **PENDING_UPDATE** β€” This status code indicates that a request to update your domain has been received and is being processed.\n- **REDEMPTION_PERIOD** β€” This status code indicates that your registrar has asked the registry to delete your domain.\n- **RENEW_PERIOD** β€” This grace period is provided after a domain name registration period is explicitly extended (renewed) by the registrar.\n- **SERVER_DELETE_PROHIBITED** β€” This status code prevents your domain from being deleted.\n- **SERVER_HOLD** β€” This status code is set by your domain's Registry Operator. Your domain is not activated in the DNS.\n- **SERVER_RENEW_PROHIBITED** β€” This status code indicates your domain's Registry Operator will not allow your registrar to renew your domain.\n- **SERVER_TRANSFER_PROHIBITED** β€” This status code prevents your domain from being transferred from your current registrar to another.\n- **SERVER_UPDATE_PROHIBITED** β€” This status code locks your domain preventing it from being updated.\n- **TRANSFER_PERIOD** β€” This grace period is provided after the successful transfer of a domain name from one registrar to another." } }, "required": [ "domainId", "domain", "status", "expirationProtected", "holdRegistrar", "locked", "v1-privacy", "renewAuto", "renewDeadline", "v1-transferProtected", "createdAt", "authCode", "nameServers", "contacts" ], "type": "object" }, "DomainDnssec": { "properties": { "algorithm": { "description": "This identifies the cryptographic algorithm used to generate the signature:\n\n- **RSAMD5** β€” [01] DRSA/MD5\n- **DSA** β€” [03] DSA/SHA1\n- **RSASHA1** β€” [05] RSA/SHA-1\n- **DSA_NSEC3_SHA1** β€” [06] DSA-NSEC3-SHA1\n- **RSASHA1_NSEC3_SHA1** β€” [07] RSASHA1-NSEC3-SHA1\n- **RSASHA256** β€” [08] RSA/SHA-256\n- **RSASHA512** β€” [10] RSA/SHA-512\n- **ECC_GOST** β€” [12] GOST R 34.10-2001\n- **ECDSAP256SHA256** β€” [13] ECDSA Curve P-256 with SHA-256\n- **ECDSAP384SHA384** β€” [14] ECDSA Curve P-384 with SHA-384\n- **ED25519** β€” [15] Ed25519\n- **ED448** β€” [16] Ed448", "enum": [ "RSAMD5", "DH", "DSA", "RSASHA1", "DSA_NSEC3_SHA1", "RSASHA1_NSEC3_SHA1", "RSASHA256", "RSASHA512", "ECC_GOST", "ECDSAP256SHA256", "ECDSAP384SHA384", "ED25519", "ED448", "PRIVATEDNS", "PRIVATEOID" ], "type": "string" }, "keyTag": { "description": "This is an integer value less than 65536 used to identify the DNSSEC record for the domain name.", "type": "integer", "format": "integer-positive", "maximum": 65536 }, "digestType": { "description": "This identifies the algorithm used to construct the digest:\n\n- **SHA1** β€” [01] SHA-1\n- **SHA256** β€” [02] SHA-256\n- **GOST** β€” [03] GOST R 34.11-94\n- **SHA384** β€” [04] SHA-384", "enum": [ "SHA1", "SHA256", "GOST", "SHA384" ], "type": "string" }, "digest": { "type": "string", "description": "The digest is an alpha-numeric value" }, "flags": { "description": "This identifies the key type; either a Zone-Signing Key or a Key-Signing Key:\n\n- **ZSK** β€” [256] Zone-Signing Key\n- **KSK** β€” [257] Key-Signing Key", "enum": [ "ZSK", "KSK" ], "type": "string" }, "publicKey": { "type": "string", "description": "Registries use this value to encrypt DS records. Decryption requires a matching public key" }, "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" } }, "required": [ "algorithm" ], "type": "object" }, "DomainPrivacyForwarding": { "properties": { "privateEmail": { "type": "string", "description": "The private email" }, "forwardingEmail": { "type": "string", "description": "The email that it forwards to" }, "emailPreference": { "type": "string", "enum": [ "EMAIL_FILTER", "EMAIL_SEND_ALL", "EMAIL_SEND_NONE" ], "description": "The email forwarding preference for the domain:\n\n- **EMAIL_FILTER** β€” Filter for spam and forward email.\n- **EMAIL_SEND_ALL** β€” Forward all email.\n- **EMAIL_SEND_NONE** β€” Don't forward email." } }, "type": "object" }, "DomainPrivacyForwardingUpdate": { "properties": { "privateEmailType": { "type": "string", "enum": [ "DEFAULT", "RANDOM" ], "description": "The private email type:\n\n- **DEFAULT** β€” Use default email address (example: domainname.com@domainsbyproxy.com)\n- **RANDOM** β€” Randomize email address, we’ll create a private email address using random characters to further protect you from unwanted spam. (5f9e6c9368a64565bf2@domainsbyproxy.com)" }, "forwardingEmail": { "type": "string", "description": "The email that it forwards to" }, "emailPreference": { "type": "string", "enum": [ "EMAIL_FILTER", "EMAIL_SEND_ALL", "EMAIL_SEND_NONE" ], "description": "The email forwarding preference for the domain:\n\n- **EMAIL_FILTER** β€” Filter for spam and forward email.\n- **EMAIL_SEND_ALL** β€” Forward all email.\n- **EMAIL_SEND_NONE** β€” Don't forward email." } }, "required": [ "privateEmailType", "emailPreference" ], "type": "object" }, "DomainNameServerUpdateV2": { "additionalProperties": false, "properties": { "nameServers": { "type": "array", "items": { "type": "string" }, "description": "Fully-qualified domain names for name servers to associate with the domain" } }, "type": "object" }, "DomainNotification": { "properties": { "notificationId": { "description": "The notification ID to be used in POST /v2/customers/{customerId}/domains/notifications to acknowledge the notification", "default": "", "type": "string" }, "type": { "description": "The type of action the notification relates to", "enum": [ "AUTH_CODE_PURCHASE", "AUTH_CODE_REGENERATE", "AUTO_RENEWAL", "BACKORDER", "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_FORWARDING_UPDATE", "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" }, "resource": { "description": "The resource the notification pertains to.", "default": "", "type": "string" }, "resourceType": { "description": "The type of resource the notification relates to", "enum": [ "CONTACT", "DOMAIN", "HOST" ], "type": "string" }, "status": { "type": "string", "enum": [ "AWAITING", "CANCELLED", "FAILED", "PENDING", "SUCCESS" ], "description": "The resulting status of the action." }, "addedAt": { "description": "The date the notification was added", "default": "", "type": "string", "format": "iso-datetime" }, "requestId": { "type": "string", "description": "A client provided identifier (via X-Request-Id header) indicating the request this notification is for" }, "metadata": { "description": "The notification data for the given type as specified by GET /v2/customers/{customerId}/domains/notifications/schema", "default": "", "type": "object" } }, "required": [ "notificationId", "type", "resource", "resourceType", "status", "addedAt" ], "type": "object" }, "DomainNotificationType": { "properties": { "type": { "description": "The notification type", "enum": [ "AUTH_CODE_PURCHASE", "AUTH_CODE_REGENERATE", "AUTO_RENEWAL", "BACKORDER", "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_FORWARDING_UPDATE", "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" } }, "required": [ "type" ], "type": "object" }, "DomainPurchase": { "properties": { "consent": { "$ref": "#/components/schemas/Consent" }, "contactAdmin": { "$ref": "#/components/schemas/Contact" }, "contactBilling": { "$ref": "#/components/schemas/Contact" }, "contactRegistrant": { "$ref": "#/components/schemas/Contact" }, "contactTech": { "$ref": "#/components/schemas/Contact" }, "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", "format": "domain", "type": "string" }, "nameServers": { "items": { "format": "host-name", "type": "string" }, "type": "array" }, "period": { "default": 1, "format": "integer-positive", "maximum": 10, "minimum": 1, "type": "integer" }, "privacy": { "default": false, "type": "boolean" }, "renewAuto": { "default": true, "type": "boolean" } }, "required": [ "domain", "consent" ], "type": "object" }, "DomainPurchaseV2": { "additionalProperties": false, "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" }, "consent": { "$ref": "#/components/schemas/ConsentV2" }, "period": { "type": "integer", "format": "integer-positive", "default": 1, "minimum": 1, "maximum": 10, "pattern": "^[0-9]+$" }, "nameServers": { "type": "array", "items": { "type": "string", "format": "host-name" }, "maxItems": 2 }, "renewAuto": { "type": "boolean", "default": true }, "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}" } }, "required": [ "domain", "consent" ], "type": "object" }, "DomainPurchaseResponse": { "properties": { "currency": { "default": "USD", "description": "Currency in which the `total` is listed", "format": "iso-currency-code", "type": "string" }, "itemCount": { "description": "Number items included in the order", "format": "integer-positive", "type": "integer" }, "orderId": { "description": "Unique identifier of the order processed to purchase the domain", "format": "integer-positive", "type": "integer" }, "total": { "description": "Total cost of the domain and any selected add-ons", "format": "currency-micro-unit", "type": "integer" } }, "required": [ "orderId", "itemCount", "total" ], "type": "object" }, "DomainRenew": { "properties": { "period": { "description": "Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to `period` specified during original purchase", "format": "integer-positive", "maximum": 10, "minimum": 1, "type": "integer" } }, "type": "object" }, "DomainRenewV2": { "additionalProperties": false, "properties": { "expires": { "type": "string", "format": "iso-datetime", "description": "Current date when this domain will expire" }, "consent": { "$ref": "#/components/schemas/ConsentRenew" }, "period": { "type": "integer", "description": "Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to `period` specified during original purchase", "format": "integer-positive", "minimum": 1, "maximum": 10, "pattern": "^[0-9]+$" } }, "required": [ "consent", "expires" ], "type": "object" }, "DomainSuggestion": { "properties": { "domain": { "description": "Suggested domain name", "type": "string" } }, "required": [ "domain" ], "type": "object" }, "DomainTransferAuthCode": { "type": "object", "additionalProperties": false, "properties": { "authCode": { "description": "Authorization code for transferring the Domain", "type": "string" } }, "required": [ "authCode" ] }, "DomainTransferStatus": { "type": "object", "additionalProperties": false, "properties": { "transferStatusCodes": { "type": "array", "items": { "type": "string", "enum": [ "CLIENT_APPROVED", "CLIENT_CANCELLED", "CLIENT_REJECTED", "PENDING", "SERVER_APPROVED", "SERVER_CANCELLED" ] }, "description": "The current registry transfer status codes of the domain:\n\n- **CLIENT_APPROVED** β€” The losing registrar approved the transfer.\n- **CLIENT_CANCELLED** β€” The gaining registrar cancelled the transfer.\n- **CLIENT_REJECTED** β€” The losing registrar rejected the transfer.\n- **PENDING** β€” The transfer is pending at the registry.\n- **SERVER_APPROVED** β€” The registry approved the transfer, auto-approve.\n- **SERVER_CANCELLED** β€” The registry cancelled the transfer." } }, "required": [ "v1-transferStatusCodes" ] }, "DomainSummary": { "properties": { "authCode": { "description": "Authorization code for transferring the Domain", "type": "string" }, "contactAdmin": { "$ref": "#/components/schemas/Contact" }, "contactBilling": { "$ref": "#/components/schemas/Contact" }, "contactRegistrant": { "$ref": "#/components/schemas/Contact" }, "contactTech": { "$ref": "#/components/schemas/Contact" }, "createdAt": { "description": "Date and time when this domain was created", "format": "date-time", "type": "string" }, "deletedAt": { "description": "Date and time when this domain was deleted", "format": "date-time", "type": "string" }, "transferAwayEligibleAt": { "description": "Date and time when this domain is eligible to transfer", "format": "date-time", "type": "string" }, "domain": { "description": "Name of the domain", "type": "string" }, "domainId": { "description": "Unique identifier for this Domain", "format": "double", "type": "number" }, "expirationProtected": { "description": "Whether or not the domain is protected from expiration", "type": "boolean" }, "expires": { "description": "Date and time when this domain will expire", "format": "date-time", "type": "string" }, "exposeWhois": { "description": "Whether or not the domain contact details should be shown in the WHOIS", "type": "boolean" }, "holdRegistrar": { "description": "Whether or not the domain is on-hold by the registrar", "type": "boolean" }, "locked": { "description": "Whether or not the domain is locked to prevent transfers", "type": "boolean" }, "nameServers": { "description": "Fully-qualified domain names for DNS servers", "items": { "format": "host-name", "type": "string" }, "type": "array" }, "privacy": { "description": "Whether or not the domain has privacy protection", "type": "boolean" }, "registrarCreatedAt": { "type": "string", "format": "iso-datetime", "description": "Date and time when this domain was created by the registrar" }, "renewAuto": { "description": "Whether or not the domain is configured to automatically renew", "type": "boolean" }, "renewDeadline": { "description": "Date the domain must renew on", "format": "date-time", "type": "string" }, "renewable": { "description": "Whether or not the domain is eligble for renewal based on status", "type": "boolean" }, "status": { "description": "Processing status of the domain\n- **ACTIVE** β€” All is well.\n- **AWAITING*** β€” System is waiting for the end-user to complete an action.\n- **CANCELLED*** β€” Domain has been cancelled, and may or may not be reclaimable.\n- **CONFISCATED** β€” Domain has been confiscated, usually for abuse, chargeback, or fraud.\n- **DISABLED*** β€” Domain has been disabled.\n- **EXCLUDED*** β€” Domain has been excluded from Firehose registration.\n- **EXPIRED*** β€” Domain has expired.\n- **FAILED*** β€” Domain has failed a required action, and the system is no longer retrying.\n- **HELD*** β€” Domain has been placed on hold, and likely requires intervention from Support.\n- **LOCKED*** β€” Domain has been locked, and likely requires intervention from Support.\n- **PARKED*** β€” Domain has been parked, and likely requires intervention from Support.\n- **PENDING*** β€” Domain is working its way through an automated workflow.\n- **RESERVED*** β€” Domain is reserved, and likely requires intervention from Support.\n- **REVERTED** β€” Domain has been reverted, and likely requires intervention from Support.\n- **SUSPENDED*** β€” Domain has been suspended, and likely requires intervention from Support.\n- **TRANSFERRED*** β€” Domain has been transferred out.\n- **UNKNOWN** β€” Domain is in an unknown state.\n- **UNLOCKED*** β€” Domain has been unlocked, and likely requires intervention from Support.\n- **UNPARKED*** β€” Domain has been unparked, and likely requires intervention from Support.\n- **UPDATED*** β€” Domain ownership has been transferred to another account.", "type": "string" }, "transferProtected": { "description": "Whether or not the domain is protected from transfer", "type": "boolean" } }, "required": [ "domainId", "domain", "status", "expirationProtected", "holdRegistrar", "locked", "v1-privacy", "renewAuto", "renewDeadline", "v1-transferProtected", "createdAt", "contactRegistrant" ], "type": "object" }, "DomainForwardingMask": { "properties": { "title": { "type": "string", "description": "Displays at the top of the browser window and in search results." }, "description": { "type": "string", "description": "A short description of your website to display in search engine results." }, "keywords": { "type": "string", "description": "A list of comma-separated keywords that describes the content and purpose of your website." } }, "type": "object" }, "DomainForwardingCreate": { "properties": { "type": { "type": "string", "default": "REDIRECT_PERMANENT", "enum": [ "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" ], "description": "The type of forwarding to implement:\n\n- **MASKED** β€” Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.\n- **REDIRECT_PERMANENT*** β€” 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.\n- **REDIRECT_TEMPORARY** β€” 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." }, "url": { "type": "string", "format": "url", "description": "Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)" }, "mask": { "$ref": "#/components/schemas/DomainForwardingMask" } }, "required": [ "type", "url" ], "type": "object" }, "DomainForwarding": { "properties": { "fqdn": { "type": "string", "description": "The fqdn (domain or sub domain) to forward (ex somedomain.com or sub.somedomain.com)" }, "type": { "type": "string", "default": "REDIRECT_PERMANENT", "enum": [ "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" ], "description": "The type of forwarding to implement:\n\n- **MASKED** β€” Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.\n- **REDIRECT_PERMANENT*** β€” 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.\n- **REDIRECT_TEMPORARY** β€” 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." }, "url": { "type": "string", "format": "url", "description": "Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)" }, "mask": { "$ref": "#/components/schemas/DomainForwardingMask" } }, "required": [ "fqdn", "type", "url" ], "type": "object" }, "DomainRedeemV2": { "additionalProperties": false, "properties": { "consent": { "$ref": "#/components/schemas/ConsentRedemption" } }, "required": [ "consent" ], "type": "object" }, "DomainTransferIn": { "properties": { "authCode": { "description": "Authorization code from registrar for transferring a domain", "type": "string" }, "consent": { "$ref": "#/components/schemas/Consent" }, "period": { "default": 1, "description": "Can be more than 1 but no more than 10 years total including current registration length", "format": "integer-positive", "maximum": 10, "minimum": 1, "type": "integer" }, "privacy": { "default": false, "description": "Whether or not privacy has been requested", "type": "boolean" }, "renewAuto": { "default": true, "description": "Whether or not the domain should be configured to automatically renew", "type": "boolean" }, "contactAdmin": { "$ref": "#/components/schemas/Contact" }, "contactBilling": { "$ref": "#/components/schemas/Contact" }, "contactRegistrant": { "$ref": "#/components/schemas/Contact" }, "contactTech": { "$ref": "#/components/schemas/Contact" } }, "required": [ "authCode", "consent" ], "type": "object" }, "DomainTransferInV2": { "additionalProperties": false, "properties": { "authCode": { "type": "string", "description": "Authorization code from registrar for transferring a domain" }, "period": { "type": "integer", "format": "integer-positive", "default": 1, "minimum": 1, "maximum": 10, "pattern": "^[0-9]+$", "description": "Can be more than 1 but no more than 10 years total including current registration length" }, "renewAuto": { "type": "boolean", "default": true, "description": "Whether or not the domain should be configured to automatically renew" }, "privacy": { "type": "boolean", "default": false, "description": "Whether or not privacy has been requested" }, "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" }, "consent": { "$ref": "#/components/schemas/ConsentV2" }, "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}" } }, "required": [ "authCode", "consent" ], "type": "object" }, "DomainUpdate": { "properties": { "locked": { "description": "Whether or not the domain should be locked to prevent transfers", "type": "boolean" }, "nameServers": { "description": "Fully-qualified domain names for Name Servers to associate with the domain", "items": { "format": "host-name" }, "type": "array" }, "renewAuto": { "description": "Whether or not the domain should be configured to automatically renew", "type": "boolean" }, "subaccountId": { "description": "Reseller subaccount shopperid who can manage the domain", "type": "string" }, "exposeRegistrantOrganization": { "type": "boolean", "description": "Whether or not the domain registrant contact organization field should be shown in the WHOIS" }, "exposeWhois": { "description": "Whether or not the domain contact details should be shown in the WHOIS", "type": "boolean" }, "consent": { "$ref": "#/components/schemas/ConsentDomainUpdate" } }, "type": "object" }, "DomainsContactsBulk": { "properties": { "contactAdmin": { "$ref": "#/components/schemas/Contact" }, "contactBilling": { "$ref": "#/components/schemas/Contact" }, "contactPresence": { "$ref": "#/components/schemas/Contact" }, "contactRegistrant": { "$ref": "#/components/schemas/Contact" }, "contactTech": { "$ref": "#/components/schemas/Contact" }, "domains": { "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`", "items": { "format": "domain", "type": "string" }, "type": "array" }, "entityType": { "description": "Canadian Presence Requirement (CA)", "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" } }, "required": [ "domains" ], "type": "object" }, "Error": { "properties": { "code": { "description": "Short identifier for the error, suitable for indicating the specific error within client code", "format": "constant", "type": "string" }, "fields": { "description": "List of the specific fields, and the errors found with their contents", "items": { "$ref": "#/components/schemas/ErrorField" }, "type": "array" }, "message": { "description": "Human-readable, English description of the error", "type": "string" } }, "required": [ "code" ], "type": "object" }, "ErrorDomainContactsValidate": { "properties": { "code": { "description": "Short identifier for the error, suitable for indicating the specific error within client code", "format": "constant", "type": "string" }, "fields": { "description": "List of the specific fields, and the errors found with their contents", "items": { "$ref": "#/components/schemas/ErrorFieldDomainContactsValidate" }, "type": "array" }, "message": { "description": "Human-readable, English description of the error", "type": "string" } }, "required": [ "code" ], "type": "object" }, "ErrorField": { "properties": { "code": { "description": "Short identifier for the error, suitable for indicating the specific error within client code", "format": "constant", "type": "string" }, "message": { "description": "Human-readable, English description of the problem with the contents of the field", "type": "string" }, "path": { "description": "- JSONPath referring to a field containing an error\n**OR**\n- JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`", "format": "json-path", "type": "string" }, "pathRelated": { "description": "JSONPath referring to a field containing an error, which is referenced by `path`", "format": "json-path", "type": "string" } }, "required": [ "path", "code" ], "type": "object" }, "ErrorFieldDomainContactsValidate": { "properties": { "code": { "description": "Short identifier for the error, suitable for indicating the specific error within client code", "format": "constant", "type": "string" }, "domains": { "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`", "items": { "type": "string" }, "type": "array" }, "message": { "description": "Human-readable, English description of the problem with the contents of the field", "type": "string" }, "path": { "description": "1) JSONPath referring to the field within the data containing an error\nor\n2) JSONPath referring to an object containing an error", "format": "json-path", "type": "string" }, "pathRelated": { "description": "JSONPath referring to the field on the object referenced by `path` containing an error", "format": "json-path", "type": "string" } }, "required": [ "code", "domains", "path" ], "type": "object" }, "ErrorLimit": { "properties": { "code": { "description": "Short identifier for the error, suitable for indicating the specific error within client code", "format": "constant", "type": "string" }, "fields": { "description": "List of the specific fields, and the errors found with their contents", "items": { "$ref": "#/components/schemas/ErrorField" }, "type": "array" }, "message": { "description": "Human-readable, English description of the error", "type": "string" }, "retryAfterSec": { "description": "Number of seconds to wait before attempting a similar request", "format": "integer-positive", "type": "integer" } }, "required": [ "retryAfterSec", "code" ], "type": "object" }, "JsonDataType": { "properties": { "format": { "type": "string" }, "pattern": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "$ref" ], "type": "object" }, "JsonProperty": { "properties": { "defaultValue": { "type": "string" }, "format": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/JsonDataType" } }, "maxItems": { "type": "integer" }, "maximum": { "type": "integer" }, "minItems": { "type": "integer" }, "minimum": { "type": "integer" }, "pattern": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "type", "required" ], "type": "object" }, "JsonSchema": { "properties": { "id": { "type": "string" }, "models": { "type": "array", "items": { "type": "object", "description": "Nested schema model" } }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/JsonProperty" } }, "required": { "type": "array", "items": { "type": "string" } }, "type": "object" }, "required": [ "id", "properties", "required", "models" ], "type": "object" }, "LegalAgreement": { "properties": { "agreementKey": { "description": "Unique identifier for the legal agreement", "type": "string" }, "content": { "description": "Contents of the legal agreement, suitable for embedding", "type": "string" }, "title": { "description": "Title of the legal agreement", "type": "string" }, "url": { "description": "URL to a page containing the legal agreement", "format": "url", "type": "string" } }, "required": [ "agreementKey", "title", "content" ], "type": "object" }, "PrivacyPurchase": { "properties": { "consent": { "$ref": "#/components/schemas/Consent" } }, "required": [ "consent" ], "type": "object" }, "RealNameValidation": { "properties": { "status": { "enum": [ "APPROVED", "PENDING", "PENDING_ASSOCIATION_WITH_DOMAIN", "PENDING_SUBMISSION_TO_VERIFICATION_SERVICE", "PENDING_VERIFICATION_SERVICE_REPLY", "PENDING_SUBMISSION_TO_REGISTRY", "PENDING_REGISTRY_REPLY", "PENDING_DOMAIN_UPDATE", "REJECTED" ], "type": "string" } }, "type": "object" }, "RenewalDetails": { "properties": { "renewable": { "type": "boolean", "description": "Whether or not the domain is eligble for renewal based on status" }, "price": { "type": "integer", "format": "currency-micro-unit", "description": "Price for the domain renewal excluding taxes or fees" }, "currency": { "type": "string", "format": "iso-currency-code", "default": "USD", "pattern": "^[A-Z][A-Z][A-Z]$", "description": "Currency in which the `price` is listed" } }, "required": [ "price", "currency" ], "type": "object" }, "TldSummary": { "properties": { "name": { "description": "Name of the top-level domain", "format": "tld", "type": "string" }, "type": { "default": "GENERIC", "description": "Type of the top-level domain", "enum": [ "COUNTRY_CODE", "GENERIC" ], "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "UsageMonthly": { "additionalProperties": false, "properties": { "details": { "type": "array", "items": { "$ref": "#/components/schemas/UsageMonthlyDetail" }, "description": "List of total request counts per endpoint." }, "quota": { "type": "integer", "description": "The total number of allowed requests in the month. See https://developer.godaddy.com/getstarted for more information on api quotas and access limits." }, "total": { "type": "integer", "description": "The total number of requests in the month." }, "yyyymm": { "type": "string", "description": "The year/month timeframe for the request counts (in the format yyyy-mm)" } }, "required": [ "total", "yyyymm" ], "type": "object" }, "UsageMonthlyDetail": { "additionalProperties": false, "properties": { "path": { "type": "string", "description": "The api path for the requests" }, "total": { "type": "integer", "description": "The total number of requests in the month for the request path." } }, "required": [ "path", "total" ], "type": "object" }, "VerificationDomainName": { "properties": { "status": { "description": "Status of the domain name verification", "enum": [ "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "VerificationRealName": { "properties": { "status": { "description": "Status of the real name verification:\n\n- **APPROVED** β€” All is well.\n- **PENDING** β€” Real name verification is working its way through the workflow.\n- **REJECTED_DOCUMENT_OUTDATED** β€” Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification.\n- **REJECTED_EXPIRED_BUSINESS_LICENSE** β€” Business license is expired.\n- **REJECTED_EXPIRED_ORGANIZATION_CODE** β€” Organization code certificate number has expired.\n- **REJECTED_ILLEGIBLE_DOCUMENT_NAME** β€” There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification.\n- **REJECTED_ILLEGIBLE_IDENTIFICATION** β€” Registrant identification is not clear. Upload a better image to retry.\n- **REJECTED_INCOMPLETE_IDENTIFICATION** β€” Registrant identification is incomplete.\n- **REJECTED_INCOMPLETE_REGISTRATION_LETTER** β€” Registration letter is incomplete.\n- **REJECTED_INCONSISTENT_IDENTITY_CARD** β€” Provided identity card is inconsistent with the identity card on record.\n- **REJECTED_INCONSISTENT_ORGANIZATION_CODE** β€” Provided organization information is inconsistent with the results obtained using the submitted organization code.\n- **REJECTED_INCONSISTENT_REGISTRANT_NAME** β€” Name on the registrant identification does not match the name in the system.\n- **REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE** β€” Your document contains an invalid business license or organization code certificate number.\n- **REJECTED_INVALID_DOCUMENT** β€” Document is invalid. Please upload another document to retry real name verification.\n- **REJECTED_MISMATCH_BUSINESS_ID** β€” Business id does not match the business id in the document.\n- **REJECTED_MISMATCH_BUSINESS_NAME** β€” Business name does not match the business name in the document.\n- **REJECTED_MISMATCH_DOCUMENT_ID** β€” Document id does not match the id in the document.\n- **REJECTED_MISMATCH_DOCUMENT_NAME** β€” Document name does not match the name in the document.\n- **REJECTED_MISMATCH_DOCUMENT_TYPE** β€” Document type does not match the document.\n- **REJECTED_MISMATCH_REGISTRANT_INFO** β€” The information provided for the registrant does not match the document.\n- **REJECTED_MISMATCH_REGISTRANT_LOCALITY** β€” Registrant region is overseas, but a local identity document was provided.\n- **REJECTED_MISMATCH_REGISTRANT_NAME** β€” Registrant name has been changed, so the request must be resubmitted.\n- **REJECTED_UNABLE_TO_OPEN** β€” Registrant identification could not be opened. Please upload the document again to retry real name verification.\n- **REJECTED_UNABLE_TO_VERIFY** β€” Unable to initiate verification. Please upload the document again to retry real name verification.\n- **REJECTED_UNKNOWN_ERROR** β€” Document was rejected due to an unknown error. For more information, contact customer support.\n- **UNABLE_TO_RETRIEVE_STATUS** β€” Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support.", "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" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "VerificationsDomain": { "properties": { "domainName": { "$ref": "#/components/schemas/VerificationDomainName" }, "realName": { "$ref": "#/components/schemas/VerificationRealName" } }, "type": "object" }, "VerificationsDomainV2": { "additionalProperties": false, "properties": { "icann": { "type": "string", "enum": [ "COMPLETED", "PENDING", "UNABLE_TO_RETRIEVE_STATUS" ], "description": "Status of the Icann verification of domain registrant contact by completing email and/or phone verification:\n\n- **COMPLETED** β€” Icann verification has been completed.\n- **PENDING** β€” Icann verification has not been completed.\n- **UNABLE_TO_RETRIEVE_STATUS** β€” Icann verification not supported for specified TLD." }, "realName": { "type": "string", "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" ], "description": "Status of the real name verification of an identity by comparing registration data against government issued documents:\n\n- **APPROVED** β€” All is well.\n- **PENDING** β€” Real name verification is working its way through the workflow.\n- **REJECTED_DOCUMENT_OUTDATED** β€” Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification.\n- **REJECTED_EXPIRED_BUSINESS_LICENSE** β€” Business license is expired.\n- **REJECTED_EXPIRED_ORGANIZATION_CODE** β€” Organization code certificate number has expired.\n- **REJECTED_ILLEGIBLE_DOCUMENT_NAME** β€” There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification.\n- **REJECTED_ILLEGIBLE_IDENTIFICATION** β€” Registrant identification is not clear. Upload a better image to retry.\n- **REJECTED_INCOMPLETE_IDENTIFICATION** β€” Registrant identification is incomplete.\n- **REJECTED_INCOMPLETE_REGISTRATION_LETTER** β€” Registration letter is incomplete.\n- **REJECTED_INCONSISTENT_IDENTITY_CARD** β€” Provided identity card is inconsistent with the identity card on record.\n- **REJECTED_INCONSISTENT_ORGANIZATION_CODE** β€” Provided organization information is inconsistent with the results obtained using the submitted organization code.\n- **REJECTED_INCONSISTENT_REGISTRANT_NAME** β€” Name on the registrant identification does not match the name in the system.\n- **REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE** β€” Your document contains an invalid business license or organization code certificate number.\n- **REJECTED_INVALID_DOCUMENT** β€” Document is invalid. Please upload another document to retry real name verification.\n- **REJECTED_MISMATCH_BUSINESS_ID** β€” Business id does not match the business id in the document.\n- **REJECTED_MISMATCH_BUSINESS_NAME** β€” Business name does not match the business name in the document.\n- **REJECTED_MISMATCH_DOCUMENT_ID** β€” Document id does not match the id in the document.\n- **REJECTED_MISMATCH_DOCUMENT_NAME** β€” Document name does not match the name in the document.\n- **REJECTED_MISMATCH_DOCUMENT_TYPE** β€” Document type does not match the document.\n- **REJECTED_MISMATCH_REGISTRANT_INFO** β€” The information provided for the registrant does not match the document.\n- **REJECTED_MISMATCH_REGISTRANT_LOCALITY** β€” Registrant region is overseas, but a local identity document was provided.\n- **REJECTED_MISMATCH_REGISTRANT_NAME** β€” Registrant name has been changed, so the request must be resubmitted.\n- **REJECTED_UNABLE_TO_OPEN** β€” Registrant identification could not be opened. Please upload the document again to retry real name verification.\n- **REJECTED_UNABLE_TO_VERIFY** β€” Unable to initiate verification. Please upload the document again to retry real name verification.\n- **REJECTED_UNKNOWN_ERROR** β€” Document was rejected due to an unknown error. For more information, contact customer support.\n- **UNABLE_TO_RETRIEVE_STATUS** β€” Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support." }, "domainName": { "type": "string", "enum": [ "APPROVED", "PENDING", "REJECTED", "UNABLE_TO_RETRIEVE_STATUS" ], "description": "Status of the verification of the domain name against a prohibited list maintained by the government" } }, "type": "object" }, "domain": { "properties": { "id": { "format": "double", "type": "number" } }, "type": "object" } } }, "x-ext-urls": {} }