{ "openapi": "3.1.0", "info": { "title": "Domains APIs", "description": "Domain order lifecycle: registration, renewal, search, transfers, nameservers,\nDNSSEC, privacy and GDPR, security locks, premium domains, bulk operations,\nTLD catalog, and order-scoped contacts.\nFor DNS zone record management, see the DNS API group.\n", "version": "2.0.0" }, "servers": [ { "url": "https://api.sandbox.resellerclub.com/v2", "description": "Sandbox" }, { "url": "https://api.resellerclub.com/v2", "description": "Live" } ], "security": [ { "apiKeyAuth": [], "userIdHeader": [] } ], "paths": { "/domains/{orderId}/theft-protection": { "put": { "tags": [ "Security & Locks" ], "summary": "Enable or disable theft protection", "description": "Enables or disables theft protection for a domain order.", "operationId": "updateTheftProtection", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTheftProtectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateTheftProtectionResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } } } }, "/domains/{orderId}/nameservers": { "put": { "tags": [ "Nameservers" ], "summary": "Update domain nameservers", "description": "Modifies the Name Servers of the specified Domain Registration Order.", "operationId": "updateDomainNameservers", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNameserversRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateDomainNameServerResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "UpdateDomainNameServerResponse", "x-v2-request-schema": "UpdateNameserversRequest" } }, "/domains/{orderId}/gdpr": { "put": { "tags": [ "Privacy & GDPR" ], "summary": "Enable or disable GDPR privacy protection", "description": "Enables or disables GDPR privacy protection for a domain order.", "operationId": "updateGdpr", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGdprRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateGdprResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } } } }, "/domains/{orderId}/contacts": { "put": { "tags": [ "Contacts" ], "summary": "Update domain contact assignments", "description": "Modifies the Contacts of the specified Domain Registration Order.", "operationId": "updateDomainContacts", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDomainContactsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateDomainContactsResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "UpdateDomainContactsResponse" } }, "/domains/{orderId}/auth-code": { "put": { "tags": [ "Auth Codes" ], "summary": "Modify domain authorization code", "description": "Modifies the Auth-Code of the specified Domain Registration Order.", "operationId": "updateAuthCode", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAuthCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateAuthCodeResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "UpdateAuthCodeResponse" } }, "/transfer-out/domains/search": { "post": { "tags": [ "Domain Transfer Out" ], "summary": "Search domains being transferred away (complex filters)", "description": "Returns domains being transferred away from the registrar.", "operationId": "searchTransferOutDomains", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchTransferOutDomainsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SearchTransferOutDomainsResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "SearchTransferOutDomainsResponse", "x-v2-request-schema": "SearchTransferOutDomainsRequest" } }, "/domains": { "get": { "tags": [ "Domain Details" ], "summary": "Search and list domains", "description": "Gets a list of Domain Registration Orders matching the search criteria, along with the details.", "operationId": "searchDomains", "parameters": [ { "name": "orderId", "in": "query", "description": "Order Id(s) of the Domain Registration Order(s) whose details need to be fetched", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "resellerId", "in": "query", "description": "Reseller Id(s) whose Orders need to be fetched", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "customerId", "in": "query", "description": "Customer Id(s) whose Orders need to be fetched", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "showChildOrders", "in": "query", "description": "Whether Sub-Reseller Orders need to be fetched or not", "required": false, "schema": { "type": "boolean" } }, { "name": "productKey", "in": "query", "description": "Product keys of the TLDs", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Status of the Order. Deleted — orders deleted in the past 30 days. Archived — orders deleted\nmore than 30 days ago. Pending Verification — registrant contact email verification pending.\nFailed Verification — orders deactivated because registrant contact email was not verified\nwithin the Whois Data Verification period.", "required": false, "schema": { "enum": [ "InActive", "Active", "Suspended", "Pending Delete Restorable", "Deleted", "Archived", "Pending Verification", "Failed Verification" ], "example": null } }, { "name": "privacyEnabled", "in": "query", "description": "Privacy Protection status filter. true — Privacy Protection enabled. false — disabled.\nna — not applicable (not allowed); search results include Inactive Orders as well.", "required": false, "schema": { "enum": [ "true", "false", "na" ], "example": null } }, { "name": "domainName", "in": "query", "description": "Name of the Domain.", "required": false, "schema": { "type": "string" } }, { "name": "creationDateStart", "in": "query", "description": "UNIX TimeStamp for listing of Domain Registration Orders whose Creation Date is greater than creation-date-start", "required": false, "schema": { "type": "string" } }, { "name": "creationDateEnd", "in": "query", "description": "UNIX TimeStamp for listing of Domain Registration Orders whose Creation Date is less than creation-date-end", "required": false, "schema": { "type": "string" } }, { "name": "expiryDateStart", "in": "query", "description": "UNIX TimeStamp for listing of Domain Registration Orders whose Expiry Date is greater than expiry-date-start", "required": false, "schema": { "type": "string" } }, { "name": "expiryDateEnd", "in": "query", "description": "UNIX TimeStamp for listing of Domain Registration Orders whose Expiry Date is less than expiry-date-end", "required": false, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Number of Orders to be fetched. This should be a value between 10 to 500.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Page number for which details are to be fetched", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "One or more parameters by which you want to sort the Orders. Values can be orderid , customerid , endtime , timestamp , entitytypeid , creationtime or creationdt . You can sort your results in the ascending or the descending order by passing the asc or desc parameter in the call. By default, the orders are sorted in the ascending order. Example: &order-by=timestamp desc Example : If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. If page-no is 2, no-of-records is 30 and order-by is order id; it will fetch the second batch of 30 Orders sorted by orderid.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DomainSearchResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "DomainSearchResponse" }, "post": { "tags": [ "Domain Lifecycle" ], "summary": "Register a new domain", "description": "Registers a domain name.", "operationId": "registerDomain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainRegistrationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RegisterDomainResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "RegisterDomainResponse", "x-v2-request-schema": "DomainRegistrationRequest" } }, "/domains/{orderId}/transfer-out/approval-resend": { "post": { "tags": [ "Domain Transfer Out" ], "summary": "Resend transfer approval (RFA) email", "description": "Resends the Transfer Approval Mail for the specified Order.", "operationId": "resendTransferApproval", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResendTransferApprovalResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ResendTransferApprovalResponse" } }, "/domains/{orderId}/transfer-in/auth-code": { "post": { "tags": [ "Domain Transfer In" ], "summary": "Submit authorization code for a transfer", "description": "Submit the Domain Secret (also known as Authorization Code) for a domain name that is currently being transferred in to Demo Registrar.", "operationId": "submitTransferAuthCode", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTransferAuthCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SubmitTransferAuthCodeResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "SubmitTransferAuthCodeResponse", "x-v2-request-schema": "SubmitTransferAuthCodeRequest" } }, "/domains/{orderId}/restore": { "post": { "tags": [ "Domain Lifecycle" ], "summary": "Restore an expired domain", "description": "Returns the result of the domain operation, including action tracking metadata.", "operationId": "restoreDomain", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreDomainRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestoreDomainResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "RestoreDomainResponse", "x-v2-request-schema": "RestoreDomainRequest" } }, "/domains/{orderId}/reseller-lock": { "post": { "tags": [ "Security & Locks" ], "summary": "Add reseller lock to domain", "description": "Returns the result of the domain operation, including action tracking metadata.", "operationId": "addResellerLock", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddResellerLockRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AddResellerLockResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "AddResellerLockResponse", "x-v2-request-schema": "AddResellerLockRequest" }, "delete": { "tags": [ "Security & Locks" ], "summary": "Remove reseller lock from domain", "description": "Returns the result of the domain operation, including action tracking metadata.", "operationId": "removeResellerLock", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RemoveResellerLockResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "RemoveResellerLockResponse" } }, "/domains/{orderId}/renew": { "post": { "tags": [ "Domain Lifecycle" ], "summary": "Renew a domain", "description": "Renews the specified Domain Registration Order for specified number of years.", "operationId": "renewDomain", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewDomainRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RenewDomainResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "RenewDomainResponse", "x-v2-request-schema": "RenewDomainRequest" } }, "/domains/{orderId}/raa-verification/resend-email": { "post": { "tags": [ "IRTP & RAA Verification" ], "summary": "Resend RAA verification email", "description": "Resends the verification email to the Registrant Contact Email Address for the specified Domain Registration Order.", "operationId": "resendRaaVerification", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResendRaaVerificationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ResendRaaVerificationResponse" } }, "/domains/{orderId}/premium-dns/purchase": { "post": { "tags": [ "Premium DNS" ], "summary": "Purchase premium DNS add-on", "description": "Purchases the premium DNS add-on for a domain order and returns per-domain outcomes.", "operationId": "purchasePremiumDns", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchasePremiumDnsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PurchasePremiumDnsResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "PurchasePremiumDnsResponse", "x-v2-request-schema": "PurchasePremiumDnsRequest" } }, "/domains/{orderId}/irtp-verification/resend": { "post": { "tags": [ "IRTP & RAA Verification" ], "summary": "Resend IRTP authorization email", "description": "Resend the Authorization email to all participants in the IRTP task.", "operationId": "resendIrtpVerification", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResendIrtpVerificationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ResendIrtpVerificationResponse" } }, "/domains/{orderId}/irtp-verification/losing-approval": { "post": { "tags": [ "IRTP & RAA Verification" ], "summary": "Approve losing IRTP authorization", "description": "Returns the result of the domain operation, including action tracking metadata.", "operationId": "approveLosingIrtpVerification", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveLosingIrtpVerificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ApproveLosingIrtpVerificationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ApproveLosingIrtpVerificationResponse", "x-v2-request-schema": "ApproveLosingIrtpVerificationRequest" } }, "/domains/{orderId}/irtp-verification/cancellation": { "post": { "tags": [ "IRTP & RAA Verification" ], "summary": "Cancel IRTP authorization", "description": "Cancels ongoing IRTP process linked to the order.", "operationId": "cancelIrtpVerification", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelIrtpVerificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CancelIrtpVerificationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "CancelIrtpVerificationResponse", "x-v2-request-schema": "CancelIrtpVerificationRequest" } }, "/domains/{orderId}/gdpr/authorization-resend": { "post": { "tags": [ "Privacy & GDPR" ], "summary": "Resend GDPR disable authorization email", "description": "The following method must be used if the customer requests to re-send the authorization email to disable the GDPR Protection setting (e.g., in situations where the Registrant contact may not have received the initial email).", "operationId": "resendGdprAuthorization", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResendGdprAuthorizationResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ResendGdprAuthorizationResponse" } }, "/domains/{orderId}/domain-protection": { "post": { "tags": [ "Privacy & GDPR" ], "summary": "Purchase privacy protection add-on", "description": "Adds / Renews the Privacy Protection service for the specified Domain Registration Order.", "operationId": "purchasePrivacyProtection", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchasePrivacyProtectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PurchasePrivacyProtectionResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "PurchasePrivacyProtectionResponse", "x-v2-request-schema": "PurchasePrivacyProtectionRequest" }, "patch": { "tags": [ "Privacy & GDPR" ], "summary": "Modify privacy protection status", "description": "Changes the Privacy Protection status of the specified Domain Registration Order.", "operationId": "updatePrivacyProtection", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePrivacyProtectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdatePrivacyProtectionResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "UpdatePrivacyProtectionResponse", "x-v2-request-schema": "UpdatePrivacyProtectionRequest" } }, "/domains/{orderId}/domain-protection/{actionName}/email-otp": { "post": { "tags": [ "Compliance & Verification" ], "summary": "Generate email OTP for a domain action", "description": "Returns the result of the domain operation, including action tracking metadata.", "operationId": "generateEmailOtp", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "actionName", "in": "path", "description": "Action Name (required).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenerateEmailOtpResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GenerateEmailOtpResponse" } }, "/domains/{orderId}/dnssec-records": { "post": { "tags": [ "DNSSEC" ], "summary": "Add a DNSSEC record", "description": "Adds a Delegation Signer (DS) Record for a Domain Registration Order. Note Currently, Demo Registrar supports DS Record only for the following domain name extensions: .COM .IN .ME .NET .ORG", "operationId": "addDnssecRecord", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDnssecRecordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AddDnssecRecordResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "AddDnssecRecordResponse" }, "delete": { "tags": [ "DNSSEC" ], "summary": "Delete a DNSSEC record", "description": "Deletes a Delegation Signer (DS) Record for a Domain Registration Order.", "operationId": "deleteDnssecRecord", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDnssecRecordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DeleteDnssecRecordResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "DeleteDnssecRecordResponse" } }, "/domains/{orderId}/claims/resend": { "post": { "tags": [ "Compliance & Verification" ], "summary": "Resend claims approval email", "description": "Returns the result of the domain operation, including action tracking metadata.", "operationId": "resendClaimsApproval", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResendClaimsApprovalResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ResendClaimsApprovalResponse" } }, "/domains/{orderId}/child-name-servers": { "post": { "tags": [ "Child Name Servers" ], "summary": "Add a child name server", "description": "Adds Child Name Servers for the specified Domain Registration Order.", "operationId": "addChildNameServer", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChildNameServerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AddChildNameServerResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "AddChildNameServerResponse", "x-v2-request-schema": "AddChildNameServerRequest" } }, "/domains/{domainName}/transfer-in": { "post": { "tags": [ "Domain Transfer In" ], "summary": "Initiate an inbound domain transfer", "description": "Transfers a domain name. Note You need to ensure that the domain name is not Locked.", "operationId": "initiateDomainTransfer", "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateDomainTransferRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InitiateDomainTransferResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "InitiateDomainTransferResponse", "x-v2-request-schema": "InitiateDomainTransferRequest" } }, "/bulk/domains": { "post": { "tags": [ "Bulk Operations" ], "summary": "Bulk register domains", "description": "Registers multiple domains in one request. Returns domains accepted for processing.", "operationId": "bulkAddDomains", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkRegisterDomainsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkAddDomainsResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "BulkAddDomainsResponse", "x-v2-request-schema": "BulkRegisterDomainsRequest" } }, "/bulk/domains/transfer-in": { "post": { "tags": [ "Bulk Operations" ], "summary": "Bulk transfer domains", "description": "Bulk transfer domains using indexed domain-nameN and auth-codeN with shared contact fields.", "operationId": "bulkTransferDomainsBulk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkTransferDomainsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkTransferDomainsBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "BulkTransferDomainsBulkResponse", "x-v2-request-schema": "BulkTransferDomainsRequest" } }, "/bulk/domains/renew": { "post": { "tags": [ "Bulk Operations" ], "summary": "Bulk renew domains", "description": "Renews multiple domains in one request.", "operationId": "bulkRenewDomainsBulk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkRenewDomainsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkRenewDomainsBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "BulkRenewDomainsBulkResponse", "x-v2-request-schema": "BulkRenewDomainsRequest" } }, "/domains/{orderId}/child-name-servers/{hostname}": { "patch": { "tags": [ "Child Name Servers" ], "summary": "Rename a child name server", "description": "Modifies the Host Name of the Child Name Server for the specified Domain Registration Order.", "operationId": "updateChildNameServerName", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "hostname", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateChildNameServerNameRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateChildNameServerNameResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "UpdateChildNameServerNameResponse", "x-v2-request-schema": "UpdateChildNameServerNameRequest" } }, "/domains/{orderId}/child-name-servers/{hostname}/ips": { "patch": { "tags": [ "Child Name Servers" ], "summary": "Update IP address for a child name server", "description": "Modifies the IP address associated with the specified Child Name Server of the specified Domain Registration Order.", "operationId": "updateChildNameServerIp", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "hostname", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateChildNameServerIpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateChildNameServerIpResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "UpdateChildNameServerIpResponse", "x-v2-request-schema": "UpdateChildNameServerIpRequest" } }, "/bulk/domains/nameservers": { "patch": { "tags": [ "Bulk Operations" ], "summary": "Bulk update domain nameservers", "description": "Bulk update nameservers for multiple domains under one customer.", "operationId": "bulkUpdateNameserversBulk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateNameserversRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkUpdateNameserversBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "BulkUpdateNameserversBulkResponse", "x-v2-request-schema": "BulkUpdateNameserversRequest" } }, "/bulk/domains/contacts": { "patch": { "tags": [ "Bulk Operations" ], "summary": "Bulk update domain contacts", "description": "Bulk update contacts for multiple domains under one customer.", "operationId": "bulkUpdateContactsBulk", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateContactsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkUpdateContactsBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "BulkUpdateContactsBulkResponse", "x-v2-request-schema": "BulkUpdateContactsRequest" } }, "/tld-catalog/trademark-notices/{lookupKey}": { "get": { "tags": [ "Compliance & Verification" ], "summary": "Get trademark notice for lookup key", "description": "Fetches the Trademark Claim Data, based on the Trademark Claim Key.", "operationId": "getTrademarkNotice", "parameters": [ { "name": "lookupKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GetTrademarkNoticeResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GetTrademarkNoticeResponse" } }, "/resellers/{resellerId}/tlds": { "get": { "tags": [ "TLD Catalog" ], "summary": "Get TLD information", "description": "Returns TLD catalog metadata for the reseller, including registry, type, and launch phases.", "operationId": "getTldInfo", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GetTldInfoResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GetTldInfoResponse" } }, "/gdpr/disabled-tlds": { "get": { "tags": [ "Privacy & GDPR" ], "summary": "List TLDs with GDPR privacy disabled", "description": "Returns TLDs where GDPR privacy protection is disabled.", "operationId": "listGdprDisabledTlds", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListGdprDisabledTldsResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ListGdprDisabledTldsResponse" } }, "/domains/{orderId}": { "get": { "tags": [ "Domain Details" ], "summary": "Get domain details by order ID", "description": "Gets details of the Domain Registration Order associated with the specified Order Id .", "operationId": "getDomainByOrderId", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "options", "in": "query", "description": "Values can be: All , OrderDetails , ContactIds , RegistrantContactDetails , AdminContactDetails , TechContactDetails , BillingContactDetails , NsDetails , DomainStatus , DNSSECDetails , StatusDetails .", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GetDomainByOrderIdResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GetDomainByOrderIdResponse" }, "delete": { "tags": [ "Domain Lifecycle" ], "summary": "Delete a domain", "description": "Deletes the specified Domain Registration Order.", "operationId": "deleteDomain", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DeleteDomainResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "DeleteDomainResponse" } }, "/domains/{orderId}/nameservers/validate": { "get": { "tags": [ "Nameservers" ], "summary": "Validate nameservers for a domain order", "description": "Returns domain availability for the requested names.", "operationId": "validateDomainNameservers", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateDomainNameserversResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ValidateDomainNameserversResponse" } }, "/domains/{orderId}/locks": { "get": { "tags": [ "Security & Locks" ], "summary": "List locks applied to a domain", "description": "Gets the list of the Locks applied on the specified Domain Registration Order.", "operationId": "listDomainLocks", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListDomainLocksResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ListDomainLocksResponse" } }, "/domains/{orderId}/irtp-verification": { "get": { "tags": [ "IRTP & RAA Verification" ], "summary": "Get IRTP verification status", "description": "Get IRTP Authorization status for an action which is waiting for IRTP Authorization", "operationId": "getIrtpVerificationStatus", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "domainName", "in": "query", "description": "Domain Name.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GetIrtpVerificationStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GetIrtpVerificationStatusResponse" } }, "/domains/{domainName}/validate-transfer-in": { "get": { "tags": [ "Domain Transfer In" ], "summary": "Validate whether a domain transfer request is valid", "description": "Checks if a transfer request is valid for the specified domain name.", "operationId": "validateTransferRequest", "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateTransferRequestResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ValidateTransferRequestResponse" } }, "/domains/idn-available": { "get": { "tags": [ "Domain Availability" ], "summary": "Check IDN domain availability", "description": "Checks the availability of the specified Internationalized Domain Name(s) (IDN).", "operationId": "checkIdnAvailability", "parameters": [ { "name": "domainName", "in": "query", "description": "Internationalized Domain Name(s) that you need to check the availability for Refer to the supported character sets mentioned below: .ASIA IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here . .BIZ IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below: Chinese Danish Finnish German Hungarian Icelandic Japanese Korean Latvian Lithuanian Norwegian Polish Portuguese Spanish Swedish .CA IDN: French characters , English alphabets and digits .CO IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below: Chinese Danish Finnish Icelandic Japanese Korean Norwegian Spanish Swedish .COM / .NET IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here . Note the character ? (codepoint=962) is not supported on our platform. .DE IDN: Restricted German characters , English alphabets and digits Note the character ß (codepoint=223) is not supported on our platform. .ES IDN: Restricted Spanish characters , English alphabets and digits .EU IDN: You can refer to supported character sets here . .IN.NET IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here . .INFO IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below: Danish German Hungarian Icelandic Korean Latvian Lithuanian Polish Spanish Swedish .NAME IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here . Note the character ? (codepoint=962) is not supported on our platform. .ORG IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below: Chinese (for IDN.org domain name and .?? domain name - the Chinese IDN for .org) Cyrillic (for .??? domain name - the Russian IDN for .org) Danish German Hindi (for .????? domain name - the Hindi IDN for .org) Hungarian Icelandic Korean Latvian Lithuanian Polish Spanish Swedish .PW IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here . .TEL IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below: Chinese Danish Finnish French German Hungarian Icelandic Japanese Korean Latvian Lithuanian Norwegian Polish Portuguese Russian Spanish Swedish CentralNic IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below: .EU.COM: Arabic Cyrillic Greek Hebrew Latin .GB.COM: Latin .AE.ORG: Arabic .KR.COM: Korean .US.COM: Arabic Chinese Cyrillic Greek Hebrew Japanese Latin .QC.COM: Latin .DE.COM: Latin .GB.NET: Latin .NO.COM: Latin .HU.COM: Latin .GR.COM: Greek .JPN.COM: Japanese .UY.COM: Latin .ZA.COM: Latin .BR.COM: Latin .CN.COM: Chinese .SA.COM: Arabic .SE.COM: Latin .SE.NET: Latin .UK.COM: Latin .UK.NET: Latin .RU.COM: Cyrillic .?? (Chinese IDN for .online): You can refer to supported character set here . .??? (Chinese IDN for .network): You can refer to supported character set here . Note The domain name used in the API call can be in Unicode (the native language) or in Punycode format. Example : The domain name can be provided as ??111 (Unicode) or xn--111-dkd4l (Punycode). domain-name=??111 domain-name=xn--111-dkd4l", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tld", "in": "query", "description": "TLD for which the domain name availability needs to be checked See details", "required": true, "schema": { "type": "string" } }, { "name": "idnLanguageCode", "in": "query", "description": "Idn Language Code (required).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CheckIdnAvailabilityResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "CheckIdnAvailabilityResponse" } }, "/domains/by-name/{domainName}": { "get": { "tags": [ "Domain Details" ], "summary": "Get domain details by domain name", "description": "Gets details of the Domain Registration Order associated with the specified domain name.", "operationId": "getDomainByName", "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "description": "Values can be: All , OrderDetails , StatusDetails, ContactIds , RegistrantContactDetails , AdminContactDetails , TechContactDetails , BillingContactDetails , NsDetails , DomainStatus , DNSSECDetails .", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GetDomainByNameResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GetDomainByNameResponse" } }, "/domains/by-name/{domainName}/order-id": { "get": { "tags": [ "Domain Details" ], "summary": "Get order ID for a domain name", "description": "Gets the Order Id of a Registered domain name.", "operationId": "getOrderIdByDomainName", "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GetOrderIdByDomainNameResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GetOrderIdByDomainNameResponse" } }, "/domains/available": { "get": { "tags": [ "Domain Availability" ], "summary": "Check domain availability", "description": "Checks the availability of the specified domain name(s).", "operationId": "checkDomainAvailability", "parameters": [ { "name": "domainName", "in": "query", "description": "Domain name(s) that you need to check the availability for", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tlds", "in": "query", "description": "TLDs for which the domain name availability needs to be checked See details", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "dnsLookup", "in": "query", "description": "Dns Lookup.", "required": false, "schema": { "type": "boolean" } }, { "name": "countryCode", "in": "query", "description": "Country Code.", "required": false, "schema": { "type": "string" } }, { "name": "ipAddress", "in": "query", "description": "Ip Address.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DomainAvailabilityResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "DomainAvailabilityResponse" } }, "/domain-transfers/pending": { "get": { "tags": [ "Domain Transfer In" ], "summary": "List pending domain transfers", "description": "Returns pending inbound domain transfers.", "operationId": "listPendingTransfers", "parameters": [ { "name": "customerId", "in": "query", "description": "Customer Id.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "domainName", "in": "query", "description": "Domain Name.", "required": false, "schema": { "type": "string" } }, { "name": "orderId", "in": "query", "description": "Order Id.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "resellerId", "in": "query", "description": "Reseller Id.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "actionAddedRangeStart", "in": "query", "description": "Action Added Range Start.", "required": false, "schema": { "type": "string" } }, { "name": "actionAddedRangeEnd", "in": "query", "description": "Action Added Range End.", "required": false, "schema": { "type": "string" } }, { "name": "actionStatus", "in": "query", "description": "Action Status.", "required": false, "schema": { "type": "string" } }, { "name": "showChildOrders", "in": "query", "description": "Show Child Orders.", "required": false, "schema": { "type": "boolean" } }, { "name": "size", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Sort.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListPendingTransfersResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ListPendingTransfersResponse" } }, "/domain-availability/premium/{domainName}": { "get": { "tags": [ "Domain Availability" ], "summary": "Check if a specific domain is premium", "description": "This method can be used to identify if the domain name specified is a premium domain name along with its pricing details.", "operationId": "checkPremiumDomain", "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CheckPremiumDomainResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "CheckPremiumDomainResponse" } }, "/domain-availability/landrush": { "get": { "tags": [ "Domain Availability" ], "summary": "Check landrush availability", "description": "Returns the operation result.", "operationId": "checkLandrushAvailability", "parameters": [ { "name": "domainName", "in": "query", "description": "Domain Name (required).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DomainLandRushAvailabilityResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "DomainLandRushAvailabilityResponse" } }, "/domain-availability/idn/validate": { "get": { "tags": [ "Domain Availability" ], "summary": "Validate IDN domain name and language code", "description": "Returns domain availability for the requested names.", "operationId": "validateIdnDomain", "parameters": [ { "name": "domainName", "in": "query", "description": "Domain Name (required).", "required": true, "schema": { "type": "string" } }, { "name": "idnLanguageCode", "in": "query", "description": "Idn Language Code (required).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateIdnDomainResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "ValidateIdnDomainResponse" } }, "/customers/{customerId}/default-nameservers": { "get": { "tags": [ "Nameservers" ], "summary": "Get customer default nameservers", "description": "Gets the default Name Servers of the specified Customer.", "operationId": "getCustomerDefaultNameservers", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GetCustomerDefaultNameserversResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "GetCustomerDefaultNameserversResponse" } }, "/domains/{orderId}/gdpr/disable": { "delete": { "tags": [ "Privacy & GDPR" ], "summary": "Cancel pending GDPR disable action", "description": "Returns the result of the GDPR privacy operation.", "operationId": "cancelGdprDisable", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CancelGdprDisableResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "CancelGdprDisableResponse" } }, "/domains/{orderId}/child-name-servers/{cns}/ips/{ip}": { "delete": { "tags": [ "Child Name Servers" ], "summary": "Delete an IP from a child name server", "description": "Deletes the IP address associated with the specified Child Name Server of the particular Domain Registration Order.", "operationId": "deleteChildNameServerIp", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "cns", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ip", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DeleteChildNameServerIpResponse" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } }, "x-v2-response-schema": "DeleteChildNameServerIpResponse" } } }, "components": { "schemas": { "GenericResponse": { "type": "object", "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "customLogMessage": {} } }, "UpdateTheftProtectionRequest": { "type": "object", "description": "Enables or disables theft protection for a domain order.", "properties": { "enabled": { "type": "boolean", "description": "When true, enables theft protection; when false, disables it." }, "otp": { "type": "string", "description": "One-time password when required for the operation." }, "twoFactorType": { "type": "string", "description": "Two-factor authentication type when required." } }, "required": [ "enabled" ] }, "UpdateNameserversRequest": { "type": "object", "description": "Modifies the Name Servers of the specified Domain Registration Order.", "properties": { "ns": { "type": "array", "description": "New Name Servers. A maximum of 13 Name Servers can be specified(repeatable).", "items": { "type": "string" }, "minItems": 1 }, "otp": { "type": "string", "description": "OTP to authenticate the request when two-factor authentication is enabled." }, "twoFactorType": { "description": "Type of 2FA authentication.", "enum": [ "email" ], "example": null } }, "required": [ "ns" ] }, "UpdateGdprRequest": { "type": "object", "description": "Enables or disables GDPR privacy protection for a domain order.", "properties": { "enabled": { "type": "boolean", "description": "When true, enables GDPR protection; when false, disables it." } }, "required": [ "enabled" ] }, "RegistrationAttribute": { "type": "object", "description": "TLD-specific extension attribute name and value pair.", "properties": { "name": { "type": "string", "description": "Attribute name for the TLD-specific extension.\n\n### Supported attribute keys\n- **idnLanguageCode** — IDN language code for the character set; codes vary by TLD (e.g. ko, de, latin).\n- **phase** — Registration phase for sunrise, prega, or landrush.\n- **smd** — Content of the SMD file (sunrise phase).\n- **tm-claim** — Trademark claim acceptance — use value accepted.\n- **cedcontactid** — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).\n- **id-type** — .AU eligibility ID type.\n- **id** — .AU eligibility ID matching the selected id-type (number or string).\n- **policyReason** — .AU eligibility reason when registering an .AU domain.\n- **isAUWarranty** — .AU registrant warranty acceptance — must be true when sent.\n- **eligibilityType** — .AU eligibility type — required for Trademark/Other id-type (e.g. Trademark Owner or Pending TM Owner, Other).\n- **eligibilityName** — .AU eligibility name (company name) — required for Trademark id-type.\n- **registrantName** — .AU registrant name — required for certain BN/Trademark/Other id-types; must be an individual proprietor.\n- **organisationId** — .BR tax/organisation ID (CPF for individual, CNPJ for company).\n- **cnhosting** — .CN hosting in China — true when domain will be hosted in China.\n- **cnhostingclause** — .CN hosting terms acceptance — yes when registrant agrees.\n- **tnc** — Terms and conditions acceptance — Y/y for European registrant data-sharing or gTLD TNC.\n- **intended-use** — .QUEBEC / .SCOT intended use description (e.g. commercial use).\n- **whois-type** — .TEL whois type for registrant.\n- **publish** — .TEL publish contact details in WHOIS (required when whois-type is Natural).\n- **service-contact** — .UK service contact ID for non-UK registrant on 2nd level .UK domains.\n- **regulatorybody** — Regulatory body for professional TLDs (.LAWYER, .DENTIST, etc.) when offering professional services.\n- **registrant-org-consent** — Registrant organization consent for gTLDs with registrant organization value.\n- **premium** — Registry premium domain registration — true.\n- **eap** — Early Access Program registration — true.", "minLength": 1 }, "value": { "type": "string", "description": "Attribute value. Meaning depends on name — see the\nattribute catalog and value tables on DomainRegistrationRequest.attributes.", "minLength": 1 } }, "required": [ "name", "value" ] }, "UpdateDomainContactsRequest": { "type": "object", "description": "Modifies the Contacts of the specified Domain Registration Order.", "properties": { "regContactId": { "type": "integer", "format": "int32", "description": "Contact to use as the new Registrant Contact." }, "adminContactId": { "type": "integer", "format": "int32", "description": "Contact to use as the new Admin Contact." }, "techContactId": { "type": "integer", "format": "int32", "description": "Contact to use as the new Technical Contact." }, "billingContactId": { "type": "integer", "format": "int32", "description": "Contact to use as the new Billing Contact." }, "sixtyDayLockOptout": { "type": "boolean", "description": "Opt out of the 60-day lock placed after Registrant Contact change (gTLDs, IRTP opt-in registrars)." }, "designatedAgent": { "type": "boolean", "description": "Pass true to opt for Designated Agent (default false)." }, "attributes": { "type": "array", "description": "Optional extra details as name/value pairs\n(e.g. skipIRTP, tnc for .FR/.SCOT/.NZ).", "items": { "$ref": "#/components/schemas/RegistrationAttribute" } } }, "required": [ "adminContactId", "billingContactId", "regContactId", "techContactId" ] }, "UpdateAuthCodeRequest": { "type": "object", "description": "Modifies the Auth-Code of the specified Domain Registration Order.", "properties": { "authCode": { "type": "string", "description": "Domain authorization code. For gTLDs, must contain at least one letter, one number, and one special character; this requirement may not apply to ccTLDs.", "minLength": 1 }, "otp": { "type": "string", "description": "OTP to authenticate the request when two-factor authentication is enabled." }, "twoFactorType": { "description": "Type of 2FA authentication.", "enum": [ "email" ], "example": null } }, "required": [ "authCode" ] }, "SearchTransferOutDomainsRequest": { "type": "object", "description": "Request body for the SearchTransferOutDomains operation.", "properties": { "productkey": { "type": "string" }, "domainname": { "type": "string" }, "noOfRecords": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "sort": { "type": "string" } }, "required": [ "noOfRecords", "pageNo" ] }, "TransferOutDomainDto": { "type": "object", "description": "Domain being transferred away from the registrar.", "properties": { "actionAdded": { "type": "string", "description": "Timestamp when the transfer-away action was added." }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "domainName": { "type": "string", "description": "Fully qualified domain name (FQDN)." }, "orderId": { "type": "string", "description": "Domain registration order identifier." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." } } }, "DomainRegistrationRequest": { "type": "object", "description": "Register a new domain.", "properties": { "domainName": { "type": "string", "description": "Domain name that you need to Register. For an Internationalized Domain Name, refer to\nthe supported character sets per TLD (.ASIA, .BIZ, .CA, .CO, .COM/.NET, .DE, .ES, .EU,\n.IN.NET, .INFO, .NAME, .ORG, .PW, .TEL, CentralNic IDN TLDs, etc.). The domain name\nmay be provided in Unicode (native language) or Punycode format.", "minLength": 1 }, "years": { "type": "integer", "format": "int32", "description": "Number of years for which you wish to Register this domain name. Note: .AI domains can\nonly be registered for 2 years.", "minimum": 1 }, "ns": { "type": "array", "description": "The Name Servers of the domain name. Submitted as repeatable form field ns.", "items": { "type": "string" }, "minItems": 1 }, "customerId": { "type": "integer", "format": "int32", "description": "The Customer for whom you wish to Register this domain name." }, "regContactId": { "type": "integer", "format": "int32", "description": "The Registrant Contact of the domain name." }, "adminContactId": { "type": "integer", "format": "int32", "description": "The Administrative Contact of the domain name. Note: Pass -1 for .EU, .RU, .UK." }, "techContactId": { "type": "integer", "format": "int32", "description": "The Technical Contact of the domain name. Note: Pass -1 for .EU, .FR, .RU, .UK." }, "billingContactId": { "type": "integer", "format": "int32", "description": "The Billing Contact of the domain name. Note: Pass -1 for .AT, .BERLIN, .CA, .EU, .FR,\n.NL, .NZ, .RU, .UK, .LONDON." }, "invoiceOption": { "description": "Controls how the Customer Invoice will be handled for this registration order.\n\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| NoInvoice | No invoice; order executed immediately |\n| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |\n| KeepInvoice | Invoice for later payment; order executed |\n| OnlyAdd | Invoice for later payment; registration pending until paid |", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice", "OnlyAdd" ], "minLength": 1, "example": null }, "autoRenew": { "type": "boolean", "description": "Enables or disables the Auto Renewal setting for the domain name." }, "protectPrivacy": { "type": "boolean", "description": "Enables or disables the Privacy Protection setting for the domain name." }, "purchasePrivacy": { "type": "boolean", "description": "Adds the Privacy Protection service for the domain name. Not supported for .ASIA, .AT,\n.AU, .CA, .CL, .CN, .ORG.CO/.MIL.CO/.GOV.CO/.EDU.CO, .DE, .ES, .EU, .FR, .HN, .IN, .NL,\n.NZ, .PRO, .RU, .SX, .TEL, .UK, .US." }, "purchasePremiumDns": { "type": "boolean", "description": "Purchase Premium DNS service." }, "attributes": { "type": "array", "description": "Optional TLD-specific and phase-specific extra details. Each entry is a name/value pair\nfor extensions such as IDN language codes, sunrise phase, or registry premium flags.\n\n### Supported attribute keys\n- **idnLanguageCode** — IDN language code for the character set; codes vary by TLD (e.g. ko, de, latin).\n- **phase** — Registration phase for sunrise, prega, or landrush.\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| sunrise | Sunrise phase registration — requires smd attribute |\n| prega | Regular pre-registration phase |\n| landrush | Priority pre-registration (landrush) phase |\n\n- **smd** — Content of the SMD file (sunrise phase).\n- **tm-claim** — Trademark claim acceptance — use value accepted.\n- **cedcontactid** — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).\n- **id-type** — .AU eligibility ID type.\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| ACN | Australian Company Number |\n| ABN | Australian Business Number |\n| VIC BN | Victoria Business Number |\n| NSW BN | New South Wales Business Number |\n| SA BN | South Australia Business Number |\n| NT BN | Northern Territory Business Number |\n| WA BN | Western Australia Business Number |\n| TAS BN | Tasmania Business Number |\n| ACT BN | Australian Capital Territory Business Number |\n| QLD BN | Queensland Business Number |\n| TM | Trademark |\n| ARBN | Australian Registered Body Number |\n| Other | Other eligibility ID type — requires eligibilityType |\n\n- **id** — .AU eligibility ID matching the selected id-type (number or string).\n- **policyReason** — .AU eligibility reason when registering an .AU domain.\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| 1 | Exact match, abbreviation, or acronym of domain name |\n| 2 | Close and substantial connection to the domain name |\n\n- **isAUWarranty** — .AU registrant warranty acceptance — must be true when sent.\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| true | True |\n| false | False |\n\n- **eligibilityType** — .AU eligibility type — required for Trademark/Other id-type (e.g. Trademark Owner or Pending TM Owner, Other).\n- **eligibilityName** — .AU eligibility name (company name) — required for Trademark id-type.\n- **registrantName** — .AU registrant name — required for certain BN/Trademark/Other id-types; must be an individual proprietor.\n- **organisationId** — .BR tax/organisation ID (CPF for individual, CNPJ for company).\n- **cnhosting** — .CN hosting in China — true when domain will be hosted in China.\n- **cnhostingclause** — .CN hosting terms acceptance — yes when registrant agrees.\n- **tnc** — Terms and conditions acceptance — Y/y for European registrant data-sharing or gTLD TNC.\n- **intended-use** — .QUEBEC / .SCOT intended use description (e.g. commercial use).\n- **whois-type** — .TEL whois type for registrant.\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| Natural | Individual registrant |\n| Legal | Organization registrant |\n\n- **publish** — .TEL publish contact details in WHOIS (required when whois-type is Natural).\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| Y | Publish contact details in WHOIS |\n| N | Do not publish contact details in WHOIS (required when whois-type is Natural) |\n\n- **service-contact** — .UK service contact ID for non-UK registrant on 2nd level .UK domains.\n- **regulatorybody** — Regulatory body for professional TLDs (.LAWYER, .DENTIST, etc.) when offering professional services.\n- **registrant-org-consent** — Registrant organization consent for gTLDs with registrant organization value.\n- **premium** — Registry premium domain registration — true.\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| true | True |\n| false | False |\n\n- **eap** — Early Access Program registration — true.\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| true | True |\n| false | False |", "items": { "$ref": "#/components/schemas/RegistrationAttribute" } } }, "required": [ "adminContactId", "autoRenew", "billingContactId", "customerId", "domainName", "invoiceOption", "ns", "regContactId", "techContactId", "years" ] }, "DomainPrivacyDetailsDto": { "type": "object", "description": "Privacy protection purchase details returned with domain mutation action envelopes.", "properties": { "orderId": { "type": "string", "description": "Order identifier for the privacy protection action." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the privacy action type." }, "entityId": { "type": "string", "description": "Entity identifier for the privacy protection order." }, "actionStatus": { "type": "string", "description": "Status of the privacy protection action." }, "status": { "type": "string", "description": "Overall operation status." }, "netCustomerCost": { "type": "string", "description": "Net customer cost for privacy protection." }, "eaqId": { "type": "string", "description": "EAQ identifier for the privacy action." }, "customerId": { "type": "string", "description": "Customer identifier associated with the privacy action." }, "noOfDays": { "type": "string", "description": "Number of days covered by the privacy protection purchase." }, "description": { "type": "string", "description": "Domain or action description in the response." }, "domainName": { "type": "string", "description": "Domain name associated with the privacy protection action." }, "actionType": { "type": "string", "description": "Action type key for privacy protection." }, "invoiceId": { "type": "string", "description": "Invoice identifier for the privacy protection charge." }, "customerCost": { "type": "string", "description": "Customer cost for privacy protection." }, "actionStatusDesc": { "type": "string", "description": "Human-readable action status description." }, "priority": { "type": "string", "description": "Priority value for the privacy action when provided." }, "actionStarted": { "type": "string", "description": "Epoch timestamp when the privacy action started." }, "sellingCurrencySymbol": { "type": "string", "description": "Currency symbol for privacy selling amounts." }, "unutilisedSellingAmount": { "type": "string", "description": "Unutilised selling amount for privacy protection." }, "sellingAmount": { "type": "string", "description": "Selling amount for privacy protection." }, "statusUpdateTime": { "type": "string", "description": "Epoch timestamp of the last status update." }, "actionAdded": { "type": "string", "description": "Epoch timestamp when the privacy action was added." }, "entityTypeId": { "type": "string", "description": "Entity type identifier for the privacy action." } } }, "SubmitTransferAuthCodeRequest": { "type": "object", "description": "Submit the Domain Secret (Authorization Code) for a domain transfer in progress.\nPOST /domains/transfer/submit-auth-code. Order Id is supplied as the path variable orderId.", "properties": { "authCode": { "type": "string", "description": "Domain Secret or Authorization Code for the domain name being transferred.", "minLength": 1 } }, "required": [ "authCode" ] }, "RestoreDomainRequest": { "type": "object", "description": "Restores the specified Domain Registration Order.\nOrder Id is supplied as the path variable orderId.", "properties": { "invoiceOption": { "description": "Controls how the Customer Invoice will be handled.", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice" ], "minLength": 1, "example": null } }, "required": [ "invoiceOption" ] }, "AddResellerLockRequest": { "type": "object", "description": "Applies a Reseller Lock on the specified Domain Registration Order.", "properties": { "reason": { "type": "string", "description": "Reason for applying the Reseller Lock.", "minLength": 1 } }, "required": [ "reason" ] }, "RenewDomainRequest": { "type": "object", "description": "Renews the specified Domain Registration Order for the given number of years.", "properties": { "years": { "type": "integer", "format": "int32", "description": "Number of years for which you want to Renew this Order. Note: .AI domains can only be\nrenewed for 2 years.", "minimum": 1 }, "expDate": { "type": "integer", "format": "int64", "description": "Current Expiry Date of the Order in UNIX epoch time format." }, "invoiceOption": { "description": "Controls how the Customer Invoice will be handled.", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice", "OnlyAdd" ], "minLength": 1, "example": null }, "autoRenew": { "type": "boolean", "description": "Enables or disables the Auto Renewal setting for the domain name." }, "purchasePrivacy": { "type": "boolean", "description": "Renews the Privacy Protection service for the domain name. Not supported for .ASIA, .AT,\n.AU, .CA, .CN, .ORG.CO/.MIL.CO/.GOV.CO/.EDU.CO, .DE, .ES, .EU, .HN, .IN, .NL, .NZ, .PRO,\n.RU, .SX, .TEL, .UK, .US." }, "purchasePremiumDns": { "type": "boolean", "description": "Purchase Premium DNS Service." }, "premium": { "type": "boolean", "description": "Registry premium domain renewal. Set to true when renewing a registry premium domain." } }, "required": [ "autoRenew", "expDate", "invoiceOption", "years" ] }, "PurchasePremiumDnsRequest": { "type": "object", "description": "Request body for the PurchasePremiumDns operation.", "properties": { "invoiceOption": { "type": "string", "minLength": 1 } }, "required": [ "invoiceOption" ] }, "PurchasePremiumDnsResultEntryDto": { "type": "object", "description": "Per-domain premium DNS purchase outcome.", "properties": { "domainName": { "type": "string", "description": "Fully qualified domain name for the purchase row." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "description": { "type": "string", "description": "Domain description returned by the registrar." }, "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "status": { "type": "string", "description": "Row-level operation status (for example, Success or error)." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type identifier (for example, PurchasePremiumDNS)." }, "error": { "type": "string", "description": "Error message when the row status is error." } } }, "ApproveLosingIrtpVerificationRequest": { "type": "object", "description": "Approves losing IRTP authorization for the specified Order. Applicable for gTLDs when the\nRegistrar is opted-in for IRTP.\nOrder Id is supplied as the path variable orderId.", "properties": { "reason": { "type": "string", "description": "Reason for approving the losing IRTP authorization.", "minLength": 1 } }, "required": [ "reason" ] }, "CancelIrtpVerificationRequest": { "type": "object", "description": "Cancels an ongoing IRTP process linked to the Order. Applicable for gTLDs when the Registrar\nis opted-in for IRTP. The IRTP process cannot be cancelled if both the Old and New Registrant\nhave approved.\nthe path variable orderId.", "properties": { "reason": { "type": "string", "description": "Reason for cancellation.", "minLength": 1 } }, "required": [ "reason" ] }, "PurchasePrivacyProtectionRequest": { "type": "object", "description": "Purchases or renews the Privacy Protection add-on for an existing Domain Registration Order.\nBefore enabling Privacy Protection, the service must be purchased for the domain name.\nOrder Id is supplied as the path variable orderId.", "properties": { "invoiceOption": { "description": "Controls how the Customer Invoice will be handled.", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice", "OnlyAdd" ], "minLength": 1, "example": null }, "discountAmount": { "type": "number", "format": "double", "description": "Optional discount amount applied to this privacy protection purchase." } }, "required": [ "invoiceOption" ] }, "AddDnssecRecordRequest": { "type": "object", "description": "Adds a Delegation Signer (DS) Record for a Domain Registration Order.\nSupported TLDs include .COM, .IN, .ME, .NET, and .ORG.", "properties": { "keytag": { "type": "string", "description": "Tag value of the DNSKEY Resource Record that validates this signature.\nInteger in the range 0 to 65536.", "minLength": 1 }, "algorithm": { "type": "string", "description": "Cryptographic algorithm used to generate the signature.\nInteger in the range 0 to 255.", "minLength": 1 }, "digestType": { "description": "Algorithm type used to construct the Digest.\nValues 1, 2, and 3 for .COM / .NET; 1 and 2 for other supported extensions.\n\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| 1 | SHA-1 digest (40-character hex digest) |\n| 2 | SHA-256 digest (64-character hex digest) |\n| 3 | GOST R 34.11-94 digest (.COM / .NET only; 64-character hex digest) |", "enum": [ "1", "2", "3" ], "minLength": 1, "example": null }, "digest": { "type": "string", "description": "Alpha-numeric string from applying the Digest Type algorithm.\n40 characters for Digest Type 1; 64 characters for Digest Types 2 and 3.", "minLength": 1 } }, "required": [ "algorithm", "digest", "digestType", "keytag" ] }, "AddChildNameServerRequest": { "type": "object", "description": "Adds Child Name Servers for the specified Domain Registration Order.", "properties": { "cns": { "type": "string", "description": "Child Name Server name to add.", "minLength": 1 }, "ip": { "type": "string", "description": "IP address to associate with the Child Name Server (v1 field ip).", "minLength": 1 } }, "required": [ "cns", "ip" ] }, "InitiateDomainTransferRequest": { "type": "object", "description": "Transfers a domain name.\nUse the domain name as the path variable domainName; ensure the domain is not locked.", "properties": { "authCode": { "type": "string", "description": "Authorization Code (Domain Secret) of the domain name to transfer. Optional for most TLDs;\nrequired at order placement for .AU, .CA, .DE, .EU, .NZ. May be submitted later via\nsubmit-auth-code when omitted." }, "customerId": { "type": "integer", "format": "int32", "description": "The Customer for whom the Order should be added." }, "regContactId": { "type": "integer", "format": "int32", "description": "The Registrant Contact of the domain name. For .UK, the Registrant identity must not change\nduring transfer." }, "adminContactId": { "type": "integer", "format": "int32", "description": "The Administrative Contact. Pass -1 for .EU, .RU, .UK (no admin contact)." }, "techContactId": { "type": "integer", "format": "int32", "description": "The Technical Contact. Pass -1 for .EU, .RU, .UK." }, "billingContactId": { "type": "integer", "format": "int32", "description": "The Billing Contact. Pass -1 for .AT, .BERLIN, .CA, .EU, .NL, .NZ, .RU, .UK.\nfield billing-contact-id." }, "invoiceOption": { "description": "Controls how the Customer Invoice will be handled.", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice", "OnlyAdd" ], "minLength": 1, "example": null }, "purchasePrivacy": { "type": "boolean", "description": "Adds the Privacy Protection service. Not supported for .ASIA, .AT, .AU, .CA, .CN, .ORG.CO,\n.MIL.CO, .GOV.CO, .EDU.CO, .DE, .ES, .EU, .HN, .IN, .NL, .NZ, .PRO, .RU, .SX, .TEL, .UK,\n.US." }, "protectPrivacy": { "type": "boolean", "description": "Enables or disables the Privacy Protection setting for the domain name." }, "autoRenew": { "type": "boolean", "description": "Enables or disables the Auto Renewal setting for the domain name." }, "ns": { "type": "array", "description": "Name Servers to associate with the domain name (maximum 13). Submitted as repeatable\nform field ns.", "items": { "type": "string" } }, "purchasePremiumDns": { "type": "boolean", "description": "Purchase Premium DNS Service." }, "discountAmount": { "type": "number", "format": "double", "description": "Optional discount amount applied to this transfer." }, "attributes": { "type": "array", "description": "Optional TLD-specific extra details as name/value pairs for transfer-specific extensions.\n\n### Supported attribute keys\n- **cedcontactid** — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).\n- **type** — Premium domain type — premium (registry premium) or premiumft (aftermarket premium).\n- **premiumprice** — Aftermarket premium price when type is premiumft (used as attr-value2 with type).\n- **tnc** — Terms and conditions acceptance — Y or y for .FR, .SCOT, .NZ (EEA contact), etc.\n- **registrant-org-consent** — Registrant organization consent for gTLDs with registrant organization value.\n- **premium** — Registry premium domain transfer — set to true for premium domains.", "items": { "$ref": "#/components/schemas/RegistrationAttribute" } } }, "required": [ "adminContactId", "autoRenew", "billingContactId", "customerId", "invoiceOption", "regContactId", "techContactId" ] }, "BulkRegisterDomainsRequest": { "type": "object", "description": "Bulk register domains with repeated domain-name values and shared registration fields.", "properties": { "domainNames": { "type": "array", "description": "Domain names to register. Submitted as repeated domain-name form fields.", "items": { "type": "string", "minLength": 1 }, "minItems": 1 }, "years": { "type": "integer", "format": "int32", "description": "Registration period in years.", "minimum": 1 }, "ns": { "type": "array", "description": "Name servers for the domain. Submitted as repeatable form field ns.", "items": { "type": "string" }, "minItems": 1 }, "registrantContactId": { "type": "integer", "format": "int32", "description": "Registrant contact id (reg-contact-id)." }, "adminContactId": { "type": "integer", "format": "int32", "description": "Administrative contact id." }, "techContactId": { "type": "integer", "format": "int32", "description": "Technical contact id." }, "billingContactId": { "type": "integer", "format": "int32", "description": "Billing contact id." }, "customerId": { "type": "integer", "format": "int32", "description": "Customer id for the registration order." }, "invoiceOption": { "description": "How the customer invoice is handled for this order.\n\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| NoInvoice | No invoice; order executed immediately |\n| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |\n| KeepInvoice | Invoice for later payment; order executed |\n| OnlyAdd | Invoice for later payment; registration pending until paid |", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice", "OnlyAdd" ], "minLength": 1, "example": null }, "idnLanguage": { "type": "string", "description": "IDN language code when registering an internationalized domain name." } }, "required": [ "adminContactId", "billingContactId", "customerId", "domainNames", "invoiceOption", "ns", "registrantContactId", "techContactId", "years" ] }, "BulkTransferDomainEntry": { "type": "object", "properties": { "domainName": { "type": "string", "minLength": 1 }, "authCode": { "type": "string", "minLength": 1 } }, "required": [ "authCode", "domainName" ] }, "BulkTransferDomainsRequest": { "type": "object", "description": "Bulk transfer domains using indexed domain-nameN and auth-codeN with shared contact fields.", "properties": { "domains": { "type": "array", "description": "Domain and auth-code pairs (domain-name1/auth-code1, domain-name2/auth-code2, etc.).", "items": { "$ref": "#/components/schemas/BulkTransferDomainEntry" }, "minItems": 1 }, "registrantContactId": { "type": "integer", "format": "int32", "description": "Registrant contact id shared across all domains (reg-contact-id)." }, "adminContactId": { "type": "integer", "format": "int32", "description": "Administrative contact id." }, "techContactId": { "type": "integer", "format": "int32", "description": "Technical contact id." }, "billingContactId": { "type": "integer", "format": "int32", "description": "Billing contact id." }, "customerId": { "type": "integer", "format": "int32", "description": "Customer id for the transfer order." }, "protectPrivacy": { "type": "boolean", "description": "Whether privacy protection is enabled." }, "invoiceOption": { "description": "How the customer invoice is handled.\n\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| NoInvoice | No invoice; order executed immediately |\n| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |\n| KeepInvoice | Invoice for later payment; order executed |\n| OnlyAdd | Invoice for later payment; registration pending until paid |", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice", "OnlyAdd" ], "minLength": 1, "example": null } }, "required": [ "adminContactId", "billingContactId", "customerId", "domains", "invoiceOption", "protectPrivacy", "registrantContactId", "techContactId" ] }, "BulkRenewDomainsRequest": { "type": "object", "description": "Bulk renew domains with repeated domain-name values and shared renewal fields.", "properties": { "domainNames": { "type": "array", "description": "Domain names to renew. Submitted as repeated domain-name form fields.", "items": { "type": "string", "minLength": 1 }, "minItems": 1 }, "customerId": { "type": "integer", "format": "int32", "description": "Customer id for the renewal order." }, "tenure": { "type": "integer", "format": "int32", "description": "Renewal period.", "minimum": 1 }, "invoiceOption": { "description": "How the customer invoice is handled for this renewal.\n\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| NoInvoice | No invoice; order executed immediately |\n| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |\n| KeepInvoice | Invoice for later payment; order executed |\n| OnlyAdd | Invoice for later payment; registration pending until paid |", "enum": [ "NoInvoice", "PayInvoice", "KeepInvoice", "OnlyAdd" ], "minLength": 1, "example": null } }, "required": [ "customerId", "domainNames", "invoiceOption", "tenure" ] }, "UpdatePrivacyProtectionRequest": { "type": "object", "description": "Changes the Privacy Protection status of the specified Domain Registration Order.\nPOST /domains/modify-privacy-protection. Order Id is supplied as the path variable orderId.", "properties": { "protectPrivacy": { "type": "boolean", "description": "Enable or disable the Privacy Protection service. Possible values are true or false." }, "reason": { "type": "string", "description": "Reason for enabling or disabling Privacy Protection.", "minLength": 1 }, "otp": { "type": "string", "description": "OTP to authenticate the request when two-factor authentication is enabled." }, "twoFactorType": { "description": "Type of 2FA authentication.", "enum": [ "email" ], "example": null } }, "required": [ "protectPrivacy", "reason" ] }, "UpdateChildNameServerNameRequest": { "type": "object", "description": "Modifies the host name of a Child Name Server. Path variable hostname is sent as old-cns.", "properties": { "newCns": { "type": "string", "description": "New Child Name Server host name (new-cns).", "minLength": 1 } }, "required": [ "newCns" ] }, "UpdateChildNameServerIpRequest": { "type": "object", "description": "Modifies the IP address associated with the specified Child Name Server.\nPath variable hostname is sent as cns.", "properties": { "oldIp": { "type": "string", "description": "Currently associated IP address (old-ip).", "minLength": 1 }, "newIp": { "type": "string", "description": "New IP address to associate (new-ip).", "minLength": 1 } }, "required": [ "newIp", "oldIp" ] }, "BulkUpdateNameserversRequest": { "type": "object", "description": "Bulk update nameservers for multiple domains under one customer-id with repeated\ndomain-name values and shared ns.", "properties": { "customerId": { "type": "integer", "format": "int32", "description": "Customer id shared across all domains in the request." }, "domainNames": { "type": "array", "description": "Domain names to update. Submitted as repeated domain-name form fields.", "items": { "type": "string" }, "minItems": 1 }, "ns": { "type": "array", "description": "Name servers to apply. Submitted as repeatable form field ns.", "items": { "type": "string" } } }, "required": [ "customerId", "domainNames" ] }, "BulkUpdateContactsRequest": { "type": "object", "description": "Bulk update domain contacts for multiple domains under one customer-id with repeated\ndomain-name values and shared contact ids.", "properties": { "customerId": { "type": "integer", "format": "int32", "description": "Customer id shared across all domains in the request." }, "domainNames": { "type": "array", "description": "Domain names to update. Submitted as repeated domain-name form fields.", "items": { "type": "string" }, "minItems": 1 }, "registrantContactId": { "type": "integer", "format": "int32", "description": "Registrant contact id (reg-contact-id)." }, "adminContactId": { "type": "integer", "format": "int32", "description": "Administrative contact id." }, "techContactId": { "type": "integer", "format": "int32", "description": "Technical contact id." }, "billingContactId": { "type": "integer", "format": "int32", "description": "Billing contact id." } }, "required": [ "customerId", "domainNames" ] }, "TldInfoEntryDto": { "type": "object", "description": "Catalog metadata for one TLD.", "properties": { "tld": { "type": "string", "description": "Top-level domain or extension (for example, com, in.net)." }, "privacyAvailable": { "type": "boolean", "description": "Whether privacy protection is available for this TLD." }, "registry": { "type": "string", "description": "Registry operator name." }, "type": { "type": "string", "description": "TLD category (for example, generic or country-code)." }, "lockingAvailable": { "type": "boolean", "description": "Whether registrar lock is available for this TLD." }, "phases": { "type": "array", "description": "Launch-phase scheduling metadata for the TLD.", "items": { "$ref": "#/components/schemas/TldInfoPhaseDto" } } } }, "TldInfoPhaseDto": { "type": "object", "description": "Launch-phase scheduling metadata for a TLD.", "properties": { "phase": { "type": "string", "description": "Launch phase name (for example, ga)." }, "start": { "type": "string", "description": "Phase start timestamp when provided by the registry." } } }, "DomainSearchResultEntityDto": { "type": "object", "description": "One domain registration order row from a search result.", "properties": { "orderId": { "type": "string", "description": "Domain registration order identifier." }, "customerId": { "type": "string", "description": "Customer account identifier that owns the domain order." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "autoRenew": { "type": "boolean", "description": "Whether auto-renew is enabled on the search result row." }, "endTime": { "type": "integer", "format": "int64", "description": "End time for a TLD phase or promotion." }, "resellerLock": { "type": "boolean", "description": "Whether the reseller lock is enabled on the order." }, "timestamp": { "type": "string", "description": "Last-updated or event timestamp for the order row." }, "customerLock": { "type": "boolean", "description": "Whether the customer lock is enabled on the order." }, "entityTypeId": { "type": "string", "description": "Entity type identifier for the order record." }, "currentStatus": { "description": "Current lifecycle status of the domain registration order.", "enum": [ "InActive", "Active", "Suspended", "Pending Delete Restorable", "Deleted", "Archived", "Pending Verification", "Failed Verification" ], "example": null }, "entityTypeKey": { "type": "string", "description": "Entity type key for the search result row." }, "transferLock": { "type": "boolean", "description": "Whether the registrar transfer lock is enabled." }, "creationTime": { "type": "integer", "format": "int64", "description": "UNIX timestamp when the domain order was created." }, "privacyProtection": { "type": "boolean", "description": "Privacy protection status on the search result row." }, "entityTypeName": { "type": "string", "description": "Entity type display name for the search result row." }, "creationDt": { "type": "integer", "format": "int64", "description": "Creation date on the search result row." }, "description": { "type": "string", "description": "Free-text description of the action or domain row." } } }, "DomainChildNameServerDto": { "type": "object", "description": "Child name server hostname and associated IP addresses.", "properties": { "hostname": { "type": "string", "description": "Fully qualified child nameserver hostname." }, "ipAddresses": { "type": "array", "description": "IP addresses associated with the child nameserver.", "items": { "type": "string" } } } }, "DomainContactDetailDto": { "type": "object", "description": "Contact details embedded in a domain order response.", "properties": { "contactId": { "type": "string", "description": "Contact identifier." }, "customerId": { "type": "string", "description": "Customer identifier." }, "company": { "type": "string", "description": "Company name." }, "parentKey": { "type": "string", "description": "Parent key reference." }, "state": { "type": "string", "description": "State or province." }, "phoneCountryCode": { "type": "string", "description": "Telephone country code." }, "email": { "type": "string", "description": "Email address." }, "addressLine1": { "type": "string", "description": "Address line 1." }, "addressLine2": { "type": "string", "description": "Address line 2." }, "addressLine3": { "type": "string", "description": "Address line 3." }, "contactStatus": { "type": "string", "description": "Contact status." }, "type": { "type": "string", "description": "Contact type." }, "city": { "type": "string", "description": "City." }, "country": { "type": "string", "description": "Country code." }, "zipcode": { "type": "string", "description": "Postal or ZIP code." }, "phone": { "type": "string", "description": "Telephone number." }, "contactType": { "type": "array", "description": "Registry-specific contact type tags.", "items": { "type": "string" } } } }, "DomainDetailDto": { "type": "object", "description": "Domain registration order details for a single registration order.", "properties": { "actionCompleted": { "type": "string", "description": "Count or flag indicating how many domain actions have completed." }, "addNameServer": { "type": "string", "description": "Add Name Server for this domain operation." }, "addons": { "type": "array", "description": "Add-on products associated with the domain order.", "items": {} }, "adminContact": { "$ref": "#/components/schemas/DomainContactDetailDto", "description": "Administrative contact details for the domain order." }, "adminContactId": { "type": "string", "description": "Contact identifier for the administrative contact." }, "adminEmailAddress": { "type": "string", "description": "Email address of the administrative contact." }, "allowDeletion": { "type": "boolean", "description": "Whether the domain order can be deleted by the caller." }, "autoRenewAttemptDuration": { "type": "string", "description": "Number of days over which auto-renewal attempts are made." }, "autoRenewTermType": { "type": "string", "description": "Auto-renewal term type (for example, LONG_TERM)." }, "billingContact": { "$ref": "#/components/schemas/DomainContactDetailDto", "description": "Billing contact details for the domain order." }, "billingContactId": { "type": "string", "description": "Contact identifier for the billing contact." }, "bulkWhoisOptout": { "type": "string", "description": "Bulk WHOIS opt-out flag." }, "classKey": { "type": "string", "description": "Product class key used for pricing and availability." }, "className": { "type": "string", "description": "Java class name for the domain order type." }, "cns": { "type": "array", "description": "Child nameservers configured for the domain (hostname and IP addresses).", "items": { "$ref": "#/components/schemas/DomainChildNameServerDto" } }, "completionTime": { "type": "string", "description": "Timestamp when the operation completed." }, "createdTime": { "type": "integer", "format": "int64", "description": "Timestamp when the order record was created." }, "creationTime": { "type": "integer", "format": "int64", "description": "UNIX timestamp when the domain order was created." }, "currentOrderTenure": { "type": "string", "description": "Current order tenure in months." }, "currentStatus": { "type": "string", "description": "Current lifecycle status of the domain registration order." }, "customerCost": { "type": "string", "description": "Customer cost for the domain order." }, "customerId": { "type": "string", "description": "Customer account identifier that owns the domain order." }, "customerLock": { "type": "boolean", "description": "Whether the customer lock is enabled on the order." }, "deleteNameServer": { "type": "string", "description": "Delete Name Server for this domain operation." }, "deletedDate": { "type": "string", "description": "Date when the domain order was deleted." }, "deletionDate": { "type": "string", "description": "Date when the domain order was or will be deleted." }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "designatedAgent": { "type": "boolean", "description": "Designated agent information for transfer approval." }, "displayPrivacyEndTime": { "type": "boolean", "description": "Formatted privacy protection end time for display." }, "dnssec": { "type": "array", "description": "DNSSEC Delegation Signer (DS) records for the domain.", "items": { "$ref": "#/components/schemas/DomainDnssecDsRecordDto" } }, "domainEndTime": { "type": "integer", "format": "int64", "description": "Domain expiry timestamp as stored on the order." }, "domainHash": { "type": "string", "description": "Internal hash grouping related domain order fields." }, "domainName": { "type": "string", "description": "Fully qualified domain name (FQDN)." }, "domainProtectPlusEndTime": { "type": "string", "description": "Domain Protect Plus End Time for this domain operation." }, "domainSecret": { "type": "string", "description": "Domain authorization secret (EPP/auth code)." }, "domainStatus": { "type": "array", "description": "System lock/hold flags on the domain (for example, sixtydaylock, renewhold).", "items": { "type": "string" } }, "dpsSubscriptionLevel": { "type": "string", "description": "Domain Protect Suite subscription level." }, "effectiveServiceProviderId": { "type": "string", "description": "Effective service provider used for registry operations." }, "eaqId": { "type": "string", "description": "Entity action queue identifier when applicable." }, "enablePrivacyProtect": { "type": "boolean", "description": "Whether privacy protection should be enabled." }, "endTime": { "type": "integer", "format": "int64", "description": "End time for a TLD phase or promotion." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "entityTypeId": { "type": "string", "description": "Entity type identifier for the order record." }, "expiry": { "type": "string", "description": "Expiry timestamp or date for the domain." }, "expiryDate": { "type": "integer", "format": "int64", "description": "Human-readable or formatted domain expiry date after renewal." }, "fromAutoRenew": { "type": "boolean", "description": "Whether the renewal was triggered by the auto-renew scheduler." }, "gdpr": { "$ref": "#/components/schemas/DomainGdprDetailsDto", "description": "GDPR privacy protection details for the domain (enabled and eligible flags)." }, "gdprIndicator": { "type": "boolean", "description": "Indicator showing GDPR applicability or consent state." }, "invoiceId": { "type": "string", "description": "Invoice identifier created when the bulk operation generated billable orders." }, "isAutoRenew": { "type": "boolean", "description": "Whether automatic renewal is enabled for the domain order." }, "isBrokered": { "type": "boolean", "description": "Whether the premium domain is brokered." }, "isDomainProtectPlusAllowed": { "type": "boolean", "description": "Indicates is domain protect plus allowed." }, "isDomainProtectPlusTwoFaDisabled": { "type": "boolean", "description": "Indicates is domain protect plus two fa disabled." }, "isImmediateReseller": { "type": "boolean", "description": "Whether the order belongs to a customer directly under the reseller." }, "isOrderSuspendedUponExpiry": { "type": "boolean", "description": "Whether the order is suspended due to expiry." }, "isPremium": { "type": "boolean", "description": "Whether the domain is classified as premium." }, "isPremiumDnsAllowed": { "type": "boolean", "description": "Indicates is premium dns allowed." }, "isPremiumDnsEnabled": { "type": "boolean", "description": "Indicates is premium dns enabled." }, "isPrivacyAllowed": { "type": "boolean", "description": "Whether privacy protection is allowed for this TLD or order." }, "isPrivacyProtected": { "type": "boolean", "description": "Whether WHOIS privacy protection is currently enabled." }, "isRegistrarPrivileged": { "type": "boolean", "description": "Whether the reseller has registrar-privileged access." }, "jumpConditions": { "type": "array", "description": "Jump conditions associated with the domain order.", "items": {} }, "lockingAvailable": { "type": "boolean", "description": "Whether domain locking is available for this TLD or order." }, "modifiedChildNsIp": { "type": "string", "description": "Modified Child Ns Ip for this domain operation." }, "modifiedChildNsName": { "type": "string", "description": "Modified Child Ns Name for this domain operation." }, "moneyBackPeriod": { "type": "string", "description": "Money-back guarantee period in days." }, "multilingualFlag": { "type": "string", "description": "Multilingual support flag for the domain." }, "newRegistrar": { "type": "string", "description": "Name of the gaining registrar for an outgoing transfer." }, "ns": { "type": "string", "description": "Ns for this domain operation." }, "ns1": { "type": "string", "description": "Nameserver hostname for slot 1." }, "ns10": { "type": "string", "description": "Nameserver hostname for slot 10." }, "ns11": { "type": "string", "description": "Nameserver hostname for slot 11." }, "ns12": { "type": "string", "description": "Nameserver hostname for slot 12." }, "ns13": { "type": "string", "description": "Nameserver hostname for slot 13." }, "ns2": { "type": "string", "description": "Nameserver hostname for slot 2." }, "ns3": { "type": "string", "description": "Nameserver hostname for slot 3." }, "ns4": { "type": "string", "description": "Nameserver hostname for slot 4." }, "ns5": { "type": "string", "description": "Nameserver hostname for slot 5." }, "ns6": { "type": "string", "description": "Nameserver hostname for slot 6." }, "ns7": { "type": "string", "description": "Nameserver hostname for slot 7." }, "ns8": { "type": "string", "description": "Nameserver hostname for slot 8." }, "ns9": { "type": "string", "description": "Nameserver hostname for slot 9." }, "nsHash": { "type": "string", "description": "Ns Hash for this domain operation." }, "numberOfNameServers": { "type": "integer", "format": "int32", "description": "Number Of Name Servers for this domain operation." }, "numberOfYears": { "type": "integer", "format": "int32", "description": "Registration or renewal period in years." }, "oldRegistrar": { "type": "string", "description": "Name of the losing registrar for an incoming transfer." }, "orderId": { "type": "string", "description": "Domain registration order identifier." }, "orderStatus": { "type": "array", "description": "Registry lock/hold flags (for example, transferlock, resellerlock).", "items": { "type": "string" } }, "orderSuspendedByParent": { "type": "boolean", "description": "Whether the order is suspended by a parent account." }, "parentId": { "type": "string", "description": "Parent order identifier when this order is a child order." }, "parentKey": { "type": "string", "description": "Product parent key for bundled or dependent orders." }, "paused": { "type": "boolean", "description": "Whether the domain order is paused." }, "premiumDnsEndTime": { "type": "integer", "format": "int64", "description": "Premium Dns End Time for this domain operation." }, "premiumDnsNameServers": { "type": "string", "description": "Premium Dns Name Servers for this domain operation." }, "premiumDnsSsoLoginSupported": { "type": "boolean", "description": "Premium Dns Sso Login Supported for this domain operation." }, "privacyEndTime": { "type": "string", "description": "Privacy protection end time on the order." }, "privacyProtectEndTime": { "type": "string", "description": "Timestamp when privacy protection expires." }, "privacyProtectionStatus": { "type": "boolean", "description": "Privacy protection status label for the order." }, "productCategory": { "type": "string", "description": "Product category for the domain order." }, "productKey": { "type": "string", "description": "Product key identifying the TLD or product type." }, "raaVerificationStartTime": { "type": "string", "description": "Timestamp when RAA verification was started." }, "raaVerificationStatus": { "type": "string", "description": "Registrant email address (RAA) verification status." }, "recurring": { "type": "boolean", "description": "Whether the order is on a recurring billing cycle." }, "registrantContact": { "$ref": "#/components/schemas/DomainContactDetailDto", "description": "Registrant contact details for the domain order." }, "registrantContactId": { "type": "string", "description": "Contact identifier for the domain registrant." }, "registrantEmail": { "type": "string", "description": "Email address of the domain registrant." }, "registrantName": { "type": "string", "description": "Name of the domain registrant." }, "registrantOrgConsentDetails": { "$ref": "#/components/schemas/DomainRegistrantOrgConsentDetailsDto", "description": "Registrant organization consent details for applicable gTLD domains." }, "registrarCompanyName": { "type": "string", "description": "Registrar company name displayed to end users." }, "registrarName": { "type": "string", "description": "ICANN registrar name for the domain." }, "requestTime": { "type": "string", "description": "Timestamp when the request was received." }, "resellerCost": { "type": "string", "description": "Reseller cost for the domain order." }, "resellerId": { "type": "string", "description": "Reseller account identifier associated with the domain order." }, "resellerLock": { "type": "boolean", "description": "Whether the reseller lock is enabled on the order." }, "serviceProviderId": { "type": "string", "description": "Service provider identifier for registry routing." }, "sixtyDayLockOptOut": { "type": "boolean", "description": "Whether the registrant opted out of the 60-day transfer lock." }, "sixtyDayLockStatus": { "type": "string", "description": "Current 60-day transfer lock status after IRTP verification." }, "techContact": { "$ref": "#/components/schemas/DomainContactDetailDto", "description": "Technical contact details for the domain order." }, "techContactId": { "type": "string", "description": "Contact identifier for the technical contact." }, "timestamp": { "type": "string", "description": "Last-updated or event timestamp for the order row." }, "tncRequired": { "type": "boolean", "description": "Whether terms and conditions acceptance is required." }, "tld": { "type": "string", "description": "Top-level domain suffix (for example, com or net)." }, "transferDate": { "type": "string", "description": "Date when the domain transfer was initiated or completed." }, "transferLock": { "type": "boolean", "description": "Whether the registrar transfer lock is enabled." }, "transferOnRenewal": { "type": "boolean", "description": "Whether the domain transfers to the renewing registrar on renewal." }, "transferType": { "type": "string", "description": "Type of domain transfer (for example, incoming or outgoing)." }, "executionInfoParams": { "$ref": "#/components/schemas/DomainExecutionInfoParamsDto", "description": "Execution metadata for renewal and other domain actions." } } }, "DomainDnssecDsRecordDto": { "type": "object", "description": "DNSSEC Delegation Signer (DS) record on a domain order.", "properties": { "keytag": { "type": "string", "description": "DNSSEC key tag for the DS record." }, "algorithm": { "type": "string", "description": "DNSSEC algorithm identifier." }, "digestType": { "type": "string", "description": "Digest type used for the DS record." }, "digest": { "type": "string", "description": "DS record digest value." } } }, "DomainExecutionInfoParamsDto": { "type": "object", "description": "Execution metadata returned with domain detail responses (renewal, bulk actions, etc.).", "properties": { "rpInfoRpDomainId": { "type": "string", "description": "Registry provider domain identifier for the in-flight action." }, "invoiceId": { "type": "string", "description": "Invoice identifier associated with the domain action." }, "isBulk": { "type": "boolean", "description": "Whether the action was submitted as a bulk operation." }, "currentExpDate": { "type": "string", "description": "Current domain expiry timestamp at action time." }, "addActionUserDetails": { "type": "string", "description": "User and role details recorded when the action was created." }, "actionInvoiceMap": { "type": "string", "description": "Invoice mapping for the action." }, "role": { "type": "string", "description": "Role of the user who initiated the action." }, "paymentType": { "type": "string", "description": "Payment type used for the action." }, "rpInfoRpActionStatus": { "type": "string", "description": "Registry provider action status." }, "autoRenewal": { "type": "boolean", "description": "Whether auto-renewal was enabled for the action." }, "rpInfoRpActionId": { "type": "string", "description": "Registry provider action identifier." }, "serviceProviderId": { "type": "string", "description": "Service provider identifier for the action." }, "addActionIpAddress": { "type": "string", "description": "IP address recorded when the action was created." }, "discount": { "type": "string", "description": "Discount amount applied to the action." }, "customerCost": { "type": "string", "description": "Customer cost for the action from execution metadata." }, "userId": { "type": "string", "description": "User identifier that initiated the action." }, "noOfYears": { "type": "string", "description": "Number of years requested for renewal or registration." } } }, "DomainGdprDetailsDto": { "type": "object", "description": "GDPR privacy protection state for a domain order.", "properties": { "enabled": { "type": "boolean", "description": "Whether GDPR privacy protection is enabled for the domain." }, "eligible": { "type": "boolean", "description": "Whether the domain is eligible for GDPR privacy protection." } } }, "DomainRegistrantOrgConsentDetailsDto": { "type": "object", "description": "Registrant organization consent details for gTLD domains.", "properties": { "isRegistrantOrgConsentApplicable": { "type": "boolean", "description": "Whether registrant organization consent changes apply to this TLD." }, "isRegistrantOrgPlaceholder": { "type": "boolean", "description": "Whether the registrant organization field is a placeholder." }, "registrantOrgConsent": { "type": "string", "description": "Consent state: true if provided, false if revoked, or null if never provided." } } }, "IrtpContactInfoDto": { "type": "object", "description": "Contact details embedded in IRTP verification status.", "properties": { "organization": { "type": "string", "description": "Organization name for the contact." }, "name": { "type": "string", "description": "Contact name." }, "id": { "type": "string", "description": "Contact identifier." }, "email": { "type": "string", "description": "Contact email address." } } }, "IrtpStatusDto": { "type": "object", "description": "IRTP workflow status with losing and gaining registrar contact and FOA details.", "properties": { "losingContactInfo": { "$ref": "#/components/schemas/IrtpContactInfoDto", "description": "Contact information for the losing registrar." }, "losingFoaStatus": { "type": "string", "description": "Form of Authorization status at the losing registrar." }, "gainingContactInfo": { "$ref": "#/components/schemas/IrtpContactInfoDto", "description": "Contact information for the gaining registrar." }, "gainingFoaStatus": { "type": "string", "description": "Form of Authorization status at the gaining registrar." }, "expiry": { "type": "string", "description": "IRTP verification expiry timestamp." }, "taskStatus": { "type": "string", "description": "Workflow task status for IRTP verification." }, "message": { "type": "string", "description": "Additional IRTP status message." }, "sixtyDayLockStatus": { "type": "string", "description": "Current 60-day transfer lock status after IRTP verification." } } }, "IrtpVerificationDetailsDto": { "type": "object", "description": "IRTP verification status details for a domain order.", "properties": { "domainName": { "type": "string", "description": "Fully qualified domain name (FQDN)." }, "orderId": { "type": "string", "description": "Domain registration order identifier." }, "irtpStatus": { "$ref": "#/components/schemas/IrtpStatusDto", "description": "Nested IRTP workflow status details." } } }, "DomainAvailabilityCostEntryDto": { "type": "object", "properties": { "action": { "type": "string" }, "price": { "type": "string" }, "currency": { "type": "string" } } }, "DomainAvailabilityDto": { "type": "object", "properties": { "domainName": { "type": "string" }, "classkey": { "type": "string" }, "status": { "type": "string" }, "tmClaimsKey": { "type": "string" }, "cost": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvailabilityCostEntryDto" } }, "ror": { "type": "string" }, "sample": { "type": "string" }, "error": { "type": "string" } } }, "DomainAvailabilityErrorValueDto": { "type": "object", "properties": { "error": { "type": "string" } } }, "DomainAvailabilityResponseDto": { "type": "object", "properties": { "domains": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvailabilityDto" } }, "sample": { "type": "string" }, "errorValue": { "$ref": "#/components/schemas/DomainAvailabilityErrorValueDto" } } }, "PendingTransferDto": { "type": "object", "description": "Pending inbound domain transfer row.", "properties": { "actionId": { "type": "string", "description": "Identifier of the pending transfer action." }, "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "addedOn": { "type": "string", "description": "Timestamp when the transfer action was created." }, "customerId": { "type": "string", "description": "Customer account identifier that owns the domain order." }, "domainName": { "type": "string", "description": "Fully qualified domain name (FQDN)." }, "lastUpdatedOn": { "type": "string", "description": "Timestamp when the transfer action was last updated." }, "orderId": { "type": "string", "description": "Domain registration order identifier." }, "resellerId": { "type": "string", "description": "Reseller account identifier associated with the domain order." } } }, "DomainLandRushAvailabilityDTO": { "type": "object", "properties": { "domain": { "type": "string" }, "status": { "type": "string" } } }, "DomainLandRushAvailabilityResponseDto": { "type": "object", "properties": { "domains": { "type": "array", "items": { "$ref": "#/components/schemas/DomainLandRushAvailabilityDTO" } } } }, "DeleteDnssecRecordRequest": { "type": "object", "description": "Deletes a Delegation Signer (DS) Record for a Domain Registration Order.", "properties": { "keytag": { "type": "string", "description": "Key Tag value associated with the DS Record.", "minLength": 1 }, "algorithm": { "type": "string", "description": "Algorithm associated with the DS Record.", "minLength": 1 }, "digestType": { "description": "Digest Type associated with the DS Record.\nValues 1, 2, and 3 for .COM / .NET; 1 and 2 for other supported extensions.\n\n### Allowed values\n\n| Value | Description |\n|-------|-------------|\n| 1 | SHA-1 digest (40-character hex digest) |\n| 2 | SHA-256 digest (64-character hex digest) |\n| 3 | GOST R 34.11-94 digest (.COM / .NET only; 64-character hex digest) |", "enum": [ "1", "2", "3" ], "minLength": 1, "example": null }, "digest": { "type": "string", "description": "Digest associated with the DS Record (40 characters for type 1, 64 for types 2 and 3).", "minLength": 1 } }, "required": [ "algorithm", "digest", "digestType", "keytag" ] }, "AddChildNameServerResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "AddDnssecRecordResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "AddResellerLockResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "ApproveLosingIrtpVerificationResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "BulkAddDomainsResponse": { "type": "object", "description": "Bulk register operation result.", "properties": { "domainsInProcessing": { "type": "array", "description": "Domain names accepted for processing.", "items": { "type": "string" } }, "invalidDomains": { "type": "array", "description": "Domain names rejected by validation.", "items": { "type": "string" } } } }, "BulkRenewDomainsBulkResponse": { "type": "object", "description": "Bulk renew operation result.", "properties": { "invoiceId": { "type": "integer", "format": "int32", "description": "Invoice identifier when billing applies." }, "validOrders": { "type": "array", "description": "Domain names successfully renewed.", "items": { "type": "string" } }, "status": { "type": "string", "description": "Overall operation status." } } }, "BulkTransferDomainsBulkResponse": { "type": "object", "description": "Bulk transfer operation result.", "properties": { "invalidTransferDomain": { "type": "array", "description": "Domain names that failed transfer validation.", "items": { "type": "string" } }, "status": { "type": "string", "description": "Overall operation status." } } }, "BulkUpdateContactsBulkResponse": { "type": "object", "description": "Bulk modify-contact operation result.", "properties": { "invalidDomain": { "type": "array", "description": "Domain names that failed validation.", "items": { "type": "string" } }, "status": { "type": "string", "description": "Overall operation status." } } }, "BulkUpdateNameserversBulkResponse": { "type": "object", "description": "Bulk modify-nameserver operation result.", "properties": { "invalidDomain": { "type": "array", "description": "Domain names that failed validation.", "items": { "type": "string" } }, "status": { "type": "string", "description": "Overall operation status." } } }, "CancelGdprDisableResponse": { "type": "object", "description": "Returns the result of the GDPR privacy operation.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "domainName": { "type": "string", "description": "Fully qualified domain name (FQDN)." } } }, "CancelIrtpVerificationResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "CheckIdnAvailabilityResponse": { "type": "object", "description": "Returns internationalized domain name (IDN) availability and validation details.", "properties": { "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "classkey": { "type": "string", "description": "Product class key used for pricing and availability." } } }, "CheckPremiumDomainResponse": { "type": "object", "description": "Returns domain availability for the requested names.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "costHash": { "type": "string", "description": "Cost Hash for this domain operation." }, "premium": { "type": "boolean", "description": "Premium for this domain operation." } } }, "DeleteChildNameServerIpResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "DeleteDnssecRecordResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "DeleteDomainResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "DomainLockDetail": { "type": "object", "description": "Detail for one lock applied to a domain order (reseller, customer, or transfer lock).", "properties": { "addedBy": { "type": "string", "description": "User or system that added the domain lock." }, "brandName": { "type": "string", "description": "Brand name associated with the lock entry." }, "creationDt": { "type": "integer", "format": "int64", "description": "UNIX timestamp when the lock was created." }, "isParent": { "type": "boolean", "description": "Whether the lock was applied at the parent reseller level." }, "lockerId": { "type": "string", "description": "Identifier of the user or role that applied the lock." }, "lockerKey": { "type": "string", "description": "Lock type key (for example, resellerlock, customerlock, or transferlock)." }, "reason": { "type": "string", "description": "Reason the domain lock was applied." } } }, "DomainSearchResponse": { "type": "object", "description": "Returns domains matching the search criteria, with pagination.", "properties": { "domains": { "type": "array", "description": "Collection of domain entries returned for this operation.", "items": { "$ref": "#/components/schemas/DomainSearchResultEntityDto" } }, "totalItems": { "type": "integer", "format": "int32", "description": "Total number of matching records in the database." }, "itemsOnPage": { "type": "integer", "format": "int32", "description": "Number of records returned on this page." } } }, "GenerateEmailOtpResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "success": { "type": "boolean", "description": "Success status." } } }, "GetCustomerDefaultNameserversResponse": { "type": "object", "description": "Returns the operation result.", "properties": { "nameServers": { "type": "array", "description": "List of default name servers of the customer.", "items": { "type": "string" } } } }, "GetDomainByNameResponse": { "type": "object", "description": "Returns domain registration order details for the requested order.", "properties": { "domain": { "$ref": "#/components/schemas/DomainDetailDto", "description": "Nested domain registration order details." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "GetDomainByOrderIdResponse": { "type": "object", "description": "Returns domain registration order details for the requested order.", "properties": { "domain": { "$ref": "#/components/schemas/DomainDetailDto", "description": "Nested domain registration order details." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "GetIrtpVerificationStatusResponse": { "type": "object", "description": "Returns IRTP verification status details.", "properties": { "verification": { "$ref": "#/components/schemas/IrtpVerificationDetailsDto", "description": "IRTP (Inter-Registrar Transfer Policy) verification details." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "GetOrderIdByDomainNameResponse": { "type": "object", "description": "Returns the operation result.", "properties": { "orderId": { "type": "string", "description": "Order Id." } } }, "GetTldInfoResponse": { "type": "object", "description": "Returns TLD catalog metadata for the reseller.", "properties": { "tlds": { "type": "array", "description": "One entry per TLD returned by the catalog lookup.", "items": { "$ref": "#/components/schemas/TldInfoEntryDto" } } } }, "GetTrademarkNoticeResponse": { "type": "object", "description": "Returns the operation result.", "properties": { "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "InitiateDomainTransferResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "privacyDetails": { "$ref": "#/components/schemas/DomainPrivacyDetailsDto" } } }, "ListDomainLocksResponse": { "type": "object", "description": "Returns locks currently applied to the domain.\n\nThe registrar may return boolean lock flags (`transferlock`, `customerlock`,\n`resellerlock`), nested indexed lock detail under those keys, or both.\nOrder-level flags are returned at the response root; per-lock detail rows are\nreturned in `lockDetails`.", "properties": { "resellerLock": { "type": "boolean", "description": "Whether the reseller lock is enabled on the order." }, "transferLock": { "type": "boolean", "description": "Whether the registrar transfer lock is enabled." }, "customerLock": { "type": "boolean", "description": "Whether the customer lock is enabled on the order." }, "lockDetails": { "type": "array", "description": "Detail rows for locks currently applied to the requested domain order.", "items": { "$ref": "#/components/schemas/DomainLockDetail" } } } }, "ListGdprDisabledTldsResponse": { "type": "object", "description": "Returns TLDs where GDPR privacy protection is disabled.", "properties": { "disabledTlds": { "type": "array", "description": "TLDs where GDPR privacy protection is currently disabled.", "items": { "type": "string" } }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "count": { "type": "string", "description": "Total number of GDPR-disabled TLDs in the list response." }, "list": { "type": "array", "description": "List array of TLD suffix strings (same entries as disabledTlds).", "items": { "type": "string" } } } }, "ListPendingTransfersResponse": { "type": "object", "description": "Returns pending inbound domain transfers.", "properties": { "transfers": { "type": "array", "description": "Pending inbound domain transfers matching the query.", "items": { "$ref": "#/components/schemas/PendingTransferDto" } }, "totalItems": { "type": "integer", "format": "int32", "description": "Total number of matching records in the database." }, "itemsOnPage": { "type": "integer", "format": "int32", "description": "Number of records returned on this page." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "PurchasePremiumDnsResponse": { "type": "object", "description": "Returns per-domain premium DNS purchase outcomes.", "properties": { "results": { "type": "array", "description": "One entry per domain.", "items": { "$ref": "#/components/schemas/PurchasePremiumDnsResultEntryDto" } } } }, "PurchasePrivacyProtectionResponse": { "type": "object", "description": "Returns the result of the GDPR privacy operation.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "description": { "type": "string" } } }, "RegisterDomainResponse": { "type": "object", "description": "Domain registration action-envelope result.", "properties": { "actionStatus": { "type": "string", "description": "Workflow status of the registration action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable registration action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the registration action type." }, "entityId": { "type": "string", "description": "Entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "EAQ identifier for the registration action." }, "actionType": { "type": "string", "description": "Registration action type key." }, "currentAction": { "type": "string", "description": "Current action identifier when present in the response." }, "description": { "type": "string", "description": "Registered domain name." }, "status": { "type": "string", "description": "Overall workflow status (for example Success or PendingDomainVerification)." }, "customerId": { "type": "string", "description": "Customer identifier for the registration." }, "orderId": { "type": "string", "description": "Domain registration order identifier." }, "invoiceId": { "type": "string", "description": "Invoice identifier when billing applies." }, "sellingAmount": { "type": "string", "description": "Selling amount for the registration." }, "unutilisedSellingAmount": { "type": "string", "description": "Unutilised selling amount for the registration." }, "sellingCurrencySymbol": { "type": "string", "description": "Currency symbol for selling amounts." }, "error": { "type": "string", "description": "Advisory workflow message when the order is accepted but processing is delayed; not an HTTP error indicator." }, "privacyDetails": { "$ref": "#/components/schemas/DomainPrivacyDetailsDto", "description": "Nested privacy protection purchase details when applicable." } } }, "RemoveResellerLockResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "RenewDomainResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "expiryDate": { "type": "string", "description": "Human-readable or formatted domain expiry date after renewal." }, "fromAutoRenew": { "type": "boolean", "description": "Whether the renewal was triggered by the auto-renew scheduler." }, "isAutoRenew": { "type": "boolean", "description": "Whether automatic renewal is enabled for the domain order." }, "noOfYears": { "type": "integer", "format": "int32", "description": "Registration or renewal period in years." }, "sendInvoiceMail": { "type": "boolean", "description": "Whether an invoice email should be sent after renewal." }, "customerId": { "type": "string" }, "domainName": { "type": "string" }, "customerCost": { "type": "string" }, "orderId": { "type": "string" }, "invoiceId": { "type": "string" }, "netCustomerCost": { "type": "string" }, "endTime": { "type": "string" } } }, "ResendClaimsApprovalResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "ResendGdprAuthorizationResponse": { "type": "object", "description": "Returns the result of the GDPR privacy operation.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "ResendIrtpVerificationResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "ResendRaaVerificationResponse": { "type": "object", "description": "Returns the operation result.", "properties": { "success": { "type": "boolean", "description": "Whether the boolean-style operation succeeded." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "ResendTransferApprovalResponse": { "type": "object", "description": "Returns the operation result.", "properties": { "success": { "type": "boolean", "description": "Whether the boolean-style operation succeeded." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "RestoreDomainResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "SearchTransferOutDomainsResponse": { "type": "object", "description": "Returns domains being transferred away from the registrar.", "properties": { "domains": { "type": "array", "description": "Collection of domain entries returned for this operation.", "items": { "$ref": "#/components/schemas/TransferOutDomainDto" } }, "totalItems": { "type": "integer", "format": "int32", "description": "Total number of matching records in the database." }, "itemsOnPage": { "type": "integer", "format": "int32", "description": "Number of records returned on this page." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "SubmitTransferAuthCodeResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "error": { "type": "string", "description": "Error message when the operation failed." }, "success": { "type": "boolean", "description": "Whether the boolean-style operation succeeded." } } }, "UpdateAuthCodeResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "UpdateChildNameServerIpResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "UpdateChildNameServerNameResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "UpdateDomainContactsResponse": { "type": "object", "description": "Returns the result of the domain operation, including action tracking metadata.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "currentAction": { "type": "string" }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "designatedAgent": { "type": "boolean", "description": "Designated agent information for transfer approval." }, "sixtyDayLockOptout": { "type": "boolean", "description": "Sixty Day Lock Optout for this domain operation." } } }, "UpdateDomainNameServerResponse": { "type": "object", "description": "Returns the result of updating domain nameservers, including action tracking metadata.", "properties": { "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "currentAction": { "type": "string", "description": "Current queued action type for nameserver updates." }, "description": { "type": "string", "description": "Free-text description of the action or domain row." }, "actionType": { "type": "string", "description": "Action type code for the queued operation." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." } } }, "UpdateGdprResponse": { "type": "object", "description": "Result of enabling or disabling GDPR privacy protection.", "properties": { "actionStatus": { "type": "string", "description": "Action status for the operation." }, "entityId": { "type": "string", "description": "Entity identifier for the action." }, "status": { "type": "string", "description": "Status text." }, "message": { "type": "string", "description": "Result message." }, "domainName": { "type": "string", "description": "Domain name when returned on disable flows." } } }, "UpdatePrivacyProtectionResponse": { "type": "object", "description": "Returns the result of the GDPR privacy operation.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." }, "description": { "type": "string" } } }, "UpdateTheftProtectionResponse": { "type": "object", "description": "Result of enabling or disabling theft protection.", "properties": { "actionStatus": { "type": "string", "description": "Status code of the queued domain action." }, "actionStatusDesc": { "type": "string", "description": "Human-readable description of the action status." }, "actionTypeDesc": { "type": "string", "description": "Human-readable description of the action type (for example, Enable Theft Protection)." }, "entityId": { "type": "string", "description": "Internal entity identifier for the domain order." }, "eaqId": { "type": "string", "description": "Entity action queue identifier for tracking the operation." }, "actionType": { "type": "string", "description": "Action type code for the operation (for example, Lock or Unlock)." }, "description": { "type": "string", "description": "Domain name or free-text description of the action." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "error": { "type": "string", "description": "Error code from the operation (for example, NoError)." } } }, "ValidateDomainNameserversResponse": { "type": "object", "description": "Returns the operation result.", "properties": { "success": { "type": "boolean", "description": "Whether the boolean-style operation succeeded." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } }, "ValidateIdnDomainResponse": { "type": "object", "description": "Returns IDN validation outcome for the requested domain name.", "properties": { "domainName": { "type": "string", "description": "Domain name validated (from the response body when present, otherwise from the request)." }, "result": { "type": "string", "description": "Validation outcome. Returns \"Success\" when the response body is empty, or the\nper-domain validation message or top-level error detail." } } }, "ValidateTransferRequestResponse": { "type": "object", "description": "Returns domain availability for the requested names.", "properties": { "success": { "type": "boolean", "description": "Whether the boolean-style operation succeeded." }, "status": { "type": "string", "description": "Overall operation status (for example, Success or Failed)." }, "message": { "type": "string", "description": "Additional status or error message from the operation." } } } }, "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "description": "Reseller API key. In your own requests, send the full header value: Authorization: ApiKey YOUR_API_KEY", "name": "Authorization", "in": "header" }, "userIdHeader": { "type": "apiKey", "description": "Reseller user ID", "name": "X-User-Id", "in": "header" } } }, "tags": [ { "name": "Auth Codes" }, { "name": "Bulk Operations" }, { "name": "Child Name Servers" }, { "name": "Compliance & Verification" }, { "name": "Contacts" }, { "name": "DNSSEC" }, { "name": "Domain Availability" }, { "name": "Domain Details" }, { "name": "Domain Lifecycle" }, { "name": "Domain Transfer In" }, { "name": "Domain Transfer Out" }, { "name": "IRTP & RAA Verification" }, { "name": "Nameservers" }, { "name": "Premium DNS" }, { "name": "Privacy & GDPR" }, { "name": "Security & Locks" }, { "name": "TLD Catalog" } ] }