godaddy.domains
Module godaddy.domains
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_godaddy.domains_1.5.0.png)
ballerinax/godaddy.domains Ballerina library
Overview
This is a generated connector for GoDaddy Domains API v1 OpenAPI specification.
The GoDaddy Domains API provides capability to access GoDaddy operations related to domains.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an GoDaddy account
- Obtain tokens
- Follow this link to obtain tokens
Clients![](/images/permalink.svg)
godaddy.domains: Client![](/images/permalink.svg)
This is a generated connector for GoDaddy Domains API v1 OpenAPI specification. The GoDaddy Domains API provides capability to access GoDaddy operations related to domains.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials. Create a GoDaddy and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ote-godaddy.com/" - URL of the target service
listDomains![](/images/permalink.svg)
function listDomains(string? xShopperId, string[]? statuses, string[]? statusGroups, int? 'limit, string? marker, string[]? includes, string? modifiedDate) returns DomainSummary[]|error
Retrieve a list of Domains for the specified Shopper
Parameters
- xShopperId string? (default ()) - Shopper ID whose domains are to be retrieved
- statuses string[]? (default ()) - Only include results with
status
value in the specified set
- statusGroups string[]? (default ()) - Only include results with
status
value in any of the specified groups
- 'limit int? (default ()) - Maximum number of domains to return
- marker string? (default ()) - Marker Domain to use as the offset in results
- includes string[]? (default ()) - Optional details to be included in the response
- modifiedDate string? (default ()) - Only include results that have been modified since the specified date
Return Type
- DomainSummary[]|error - Request was successful
getAgreement![](/images/permalink.svg)
function getAgreement(string[] tlds, boolean privacy, string xMarketId, boolean? forTransfer) returns LegalAgreement[]|error
Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons
Parameters
- tlds string[] - list of TLDs whose legal agreements are to be retrieved
- privacy boolean - Whether or not privacy has been requested
- xMarketId string (default "en-US") - Unique identifier of the Market used to retrieve/translate Legal Agreements
- forTransfer boolean? (default ()) - Whether or not domain tranfer has been requested
Return Type
- LegalAgreement[]|error - Request was successful
getDomainAvailability![](/images/permalink.svg)
function getDomainAvailability(string domain, string checkType, boolean forTransfer) returns DomainAvailableResponse|error
Determine whether or not the specified domain is available for purchase
Parameters
- domain string - Domain name whose availability is to be checked
- checkType string (default "FAST") - Optimize for time ('FAST') or accuracy ('FULL')
- forTransfer boolean (default false) - Whether or not to include domains available for transfer. If set to True, checkType is ignored
Return Type
- DomainAvailableResponse|error - Request was successful
getDomainsAvailabilityBulk![](/images/permalink.svg)
function getDomainsAvailabilityBulk(string[] payload, string checkType) returns DomainAvailableBulk|DomainAvailableBulkMixed|error
Determine whether or not the specified domains are available for purchase
Parameters
- payload string[] - Domain names for which to check availability
- checkType string (default "FAST") - Optimize for time ('FAST') or accuracy ('FULL')
Return Type
- DomainAvailableBulk|DomainAvailableBulkMixed|error - Request was successful
validateContacts![](/images/permalink.svg)
function validateContacts(DomainsContactsBulk payload, int xPrivateLabelId, string marketId) returns Response|error
Validate the request body using the Domain Contact Validation Schema for specified domains.
Parameters
- payload DomainsContactsBulk - An instance document expected for domains contacts validation
- xPrivateLabelId int (default 1) - PrivateLabelId to operate as, if different from JWT
- marketId string (default "en-US") - MarketId in which the request is being made, and for which responses should be localized
purchaseDomain![](/images/permalink.svg)
function purchaseDomain(DomainPurchase payload, string? xShopperId) returns DomainPurchaseResponse|error
Purchase and register the specified Domain
Parameters
- payload DomainPurchase - An instance document expected to match the JSON schema returned by
./schema/{tld}
- xShopperId string? (default ()) - The Shopper for whom the domain should be purchased
Return Type
- DomainPurchaseResponse|error - Request was successful
retrieveSchema![](/images/permalink.svg)
function retrieveSchema(string tld) returns JsonSchema|error
Retrieve the schema to be submitted when registering a Domain for the specified TLD
Parameters
- tld string - The Top-Level Domain whose schema should be retrieved
Return Type
- JsonSchema|error - Request was successful
validateRequestBody![](/images/permalink.svg)
function validateRequestBody(DomainPurchase payload) returns Response|error
Validate the request body using the Domain Purchase Schema for the specified TLD
Parameters
- payload DomainPurchase - An instance document expected to match the JSON schema returned by
./schema/{tld}
suggestDomainNames![](/images/permalink.svg)
function suggestDomainNames(string? xShopperId, string? query, string? country, string? city, string[]? sources, string[]? tlds, int? lengthMax, int? lengthMin, int? 'limit, int waitMs) returns DomainSuggestion[]|error
Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history
Parameters
- xShopperId string? (default ()) - Shopper ID for which the suggestions are being generated
- query string? (default ()) - Domain name or set of keywords for which alternative domain names will be suggested
- country string? (default ()) - Two-letter ISO country code to be used as a hint for target region<br/><br/> NOTE: These are sample values, there are many <a href="http://www.iso.org/iso/country_codes.htm">more</a>
- city string? (default ()) - Name of city to be used as a hint for target region
- sources string[]? (default ()) - Sources to be queried<br/><br/><ul> <li><strong>CC_TLD</strong> - Varies the TLD using Country Codes</li> <li><strong>EXTENSION</strong> - Varies the TLD</li> <li><strong>KEYWORD_SPIN</strong> - Identifies keywords and then rotates each one</li> <li><strong>PREMIUM</strong> - Includes variations with premium prices</li></ul>
- tlds string[]? (default ()) - Top-level domains to be included in suggestions<br/><br/> NOTE: These are sample values, there are many <a href="http://www.godaddy.com/tlds/gtld.aspx#domain_search_form">more</a>
- lengthMax int? (default ()) - Maximum length of second-level domain
- lengthMin int? (default ()) - Minimum length of second-level domain
- 'limit int? (default ()) - Maximum number of suggestions to return
- waitMs int (default 1000) - Maximum amount of time, in milliseconds, to wait for responses If elapses, return the results compiled up to that point
Return Type
- DomainSuggestion[]|error - Request was successful
listTLDs![](/images/permalink.svg)
function listTLDs() returns TldSummary[]|error
Retrieves a list of TLDs supported and enabled for sale
Return Type
- TldSummary[]|error - Request was successful
getDomainDetail![](/images/permalink.svg)
function getDomainDetail(string domain, string? xShopperId) returns DomainDetail|error
Retrieve details for the specified Domain
Parameters
- domain string - Domain name whose details are to be retrieved
- xShopperId string? (default ()) - Shopper ID expected to own the specified domain
Return Type
- DomainDetail|error - Request was successful
cancelDomain![](/images/permalink.svg)
Cancel a purchased domain
Parameters
- domain string - Domain to cancel
updateDomain![](/images/permalink.svg)
function updateDomain(string domain, DomainUpdate payload, string? xShopperId) returns Response|error
Update details for the specified Domain
Parameters
- domain string - Domain whose details are to be updated
- payload DomainUpdate - Changes to apply to existing Domain
- xShopperId string? (default ()) - Shopper for whom Domain is to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
updateContacts![](/images/permalink.svg)
function updateContacts(string domain, DomainContacts payload, string? xShopperId) returns Response|error
Update domain
Parameters
- domain string - Domain whose Contacts are to be updated.
- payload DomainContacts - Changes to apply to existing Contacts
- xShopperId string? (default ()) - Shopper for whom domain contacts are to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
cancelPrivacy![](/images/permalink.svg)
Submit a privacy cancellation request for the given domain
Parameters
- domain string - Domain whose privacy is to be cancelled
- xShopperId string? (default ()) - Shopper ID of the owner of the domain
purchasePrivacy![](/images/permalink.svg)
function purchasePrivacy(string domain, PrivacyPurchase payload, string? xShopperId) returns DomainPurchaseResponse|error
Purchase privacy for a specified domain
Parameters
- domain string - Domain for which to purchase privacy
- payload PrivacyPurchase - Options for purchasing privacy
- xShopperId string? (default ()) - Shopper ID of the owner of the domain
Return Type
- DomainPurchaseResponse|error - Request was successful
replaceDNSRecords![](/images/permalink.svg)
function replaceDNSRecords(string domain, DNSRecord[] payload, string? xShopperId) returns Response|error
Replace all DNS Records for the specified Domain
Parameters
- domain string - Domain whose DNS Records are to be replaced
- payload DNSRecord[] - DNS Records to replace whatever currently exists
- xShopperId string? (default ()) - Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
addDNSRecord![](/images/permalink.svg)
function addDNSRecord(string domain, ArrayOfDNSRecord payload, string? xShopperId) returns Response|error
Add the specified DNS Records to the specified Domain
Parameters
- domain string - Domain whose DNS Records are to be augmented
- payload ArrayOfDNSRecord - DNS Records to add to whatever currently exists
- xShopperId string? (default ()) - Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
getDNSRecord![](/images/permalink.svg)
function getDNSRecord(string domain, string 'type, string name, string? xShopperId, int? offset, int? 'limit) returns DNSRecord[]|error
Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name
Parameters
- domain string - Domain whose DNS Records are to be retrieved
- 'type string - DNS Record Type for which DNS Records are to be retrieved
- name string - DNS Record Name for which DNS Records are to be retrieved
- xShopperId string? (default ()) - Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
- offset int? (default ()) - Number of results to skip for pagination
- 'limit int? (default ()) - Maximum number of items to return
replaceDNSRecordTypeName![](/images/permalink.svg)
function replaceDNSRecordTypeName(string domain, string 'type, string name, DNSRecordCreateTypeName[] payload, string? xShopperId) returns Response|error
Replace all DNS Records for the specified Domain with the specified Type and Name
Parameters
- domain string - Domain whose DNS Records are to be replaced
- 'type string - DNS Record Type for which DNS Records are to be replaced
- name string - DNS Record Name for which DNS Records are to be replaced
- payload DNSRecordCreateTypeName[] - DNS Records to replace whatever currently exists
- xShopperId string? (default ()) - Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
deleteDNSRecordTypeName![](/images/permalink.svg)
function deleteDNSRecordTypeName(string domain, string 'type, string name, string? xShopperId) returns Response|error
Delete all DNS Records for the specified Domain with the specified Type and Name
Parameters
- domain string - Domain whose DNS Records are to be deleted
- 'type string - DNS Record Type for which DNS Records are to be deleted
- name string - DNS Record Name for which DNS Records are to be deleted
- xShopperId string? (default ()) - Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
replaceDNSRecordType![](/images/permalink.svg)
function replaceDNSRecordType(string domain, string 'type, DNSRecordCreateType[] payload, string? xShopperId) returns Response|error
Replace all DNS Records for the specified Domain with the specified Type
Parameters
- domain string - Domain whose DNS Records are to be replaced
- 'type string - DNS Record Type for which DNS Records are to be replaced
- payload DNSRecordCreateType[] - DNS Records to replace whatever currently exists
- xShopperId string? (default ()) - Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
renewDomain![](/images/permalink.svg)
function renewDomain(string domain, DomainRenew payload, string? xShopperId) returns DomainPurchaseResponse|error
Renew the specified Domain
Parameters
- domain string - Domain to renew
- payload DomainRenew - Options for renewing existing Domain
- xShopperId string? (default ()) - Shopper for whom Domain is to be renewed. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
Return Type
- DomainPurchaseResponse|error - Request was successful
startOrRestartTransferInProcess![](/images/permalink.svg)
function startOrRestartTransferInProcess(string domain, DomainTransferIn payload, string? xShopperId) returns DomainPurchaseResponse|error
Purchase and start or restart transfer process
Parameters
- domain string - Domain to transfer in
- payload DomainTransferIn - Details for domain transfer purchase
- xShopperId string? (default ()) - The Shopper to whom the domain should be transfered
Return Type
- DomainPurchaseResponse|error - Request was successful
verifyEmail![](/images/permalink.svg)
Re-send Contact E-mail Verification for specified Domain
Parameters
- domain string - Domain whose Contact E-mail should be verified.
- xShopperId string? (default ()) - Shopper for whom domain contact e-mail should be verified. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
getDomainsForwards![](/images/permalink.svg)
function getDomainsForwards(string customerId, string fqdn, boolean? includeSubs) returns DomainForwarding[]|error
Retrieve the forwarding information for the given fqdn
Parameters
- customerId string - The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id.
- fqdn string - The fully qualified domain name whose forwarding details are to be retrieved.
- includeSubs boolean? (default ()) - Optionally include all sub domains if the fqdn specified is a domain and not a sub domain.
Return Type
- DomainForwarding[]|error - Request was successful
putDomainsForwards![](/images/permalink.svg)
function putDomainsForwards(string customerId, string fqdn, DomainForwardingCreate payload) returns Response|error
Modify the forwarding information for the given fqdn
Parameters
- customerId string - The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id.
- fqdn string - The fully qualified domain name whose forwarding details are to be modified.
- payload DomainForwardingCreate - Domain forwarding rule to create or replace on the fqdn
deleteDomainsForwards![](/images/permalink.svg)
Submit a forwarding cancellation request for the given fqdn
Parameters
- customerId string - The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id.
- fqdn string - The fully qualified domain name whose forwarding details are to be deleted.
Records![](/images/permalink.svg)
godaddy.domains: Address![](/images/permalink.svg)
Fields
- address1 string -
- address2 string? -
- city string -
- country string - Two-letter ISO country code to be used as a hint for target region<br/><br/> NOTE: These are sample values, there are many <a href='http://www.iso.org/iso/country_codes.htm'>more</a>
- postalCode string - Postal or zip code
- state string - State or province or territory
godaddy.domains: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - Represents API Key 'Authorization'
godaddy.domains: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
godaddy.domains: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
godaddy.domains: Consent![](/images/permalink.svg)
Fields
- agreedAt string - Timestamp indicating when the end-user consented to these legal agreements
- agreedBy string - Originating client IP address of the end-user's computer when they consented to these legal agreements
- agreementKeys string[] - Unique identifiers of the legal agreements to which the end-user has agreed, as returned from the/domains/agreements endpoint
godaddy.domains: ConsentDomainUpdate![](/images/permalink.svg)
Fields
- agreedAt string - Timestamp indicating when the end-user consented to these agreements
- agreedBy string - Originating client IP address of the end-user's computer when they consented to the agreements
- agreementKeys string[] - Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated<br/><ul><li><strong style='margin-left: 12px;'>EXPOSE_WHOIS</strong> - Required when the exposeWhois field is updated to true</li></ul>
godaddy.domains: Contact![](/images/permalink.svg)
Fields
- addressMailing Address -
- email string -
- fax string? -
- jobTitle string? -
- nameFirst string -
- nameLast string -
- nameMiddle string? -
- organization string? -
- phone string -
godaddy.domains: DNSRecord![](/images/permalink.svg)
Fields
- data string -
- name string -
- port int? - Service port (SRV only)
- priority int? - Record priority (MX and SRV only)
- protocol string? - Service protocol (SRV only)
- 'service string? - Service type (SRV only)
- ttl int? -
- 'type string -
- weight int? - Record weight (SRV only)
godaddy.domains: DNSRecordCreateType![](/images/permalink.svg)
Fields
- data string -
- name string -
- port int? - Service port (SRV only)
- priority int? - Record priority (MX and SRV only)
- protocol string? - Service protocol (SRV only)
- 'service string? - Service type (SRV only)
- ttl int? -
- weight int? - Record weight (SRV only)
godaddy.domains: DNSRecordCreateTypeName![](/images/permalink.svg)
Fields
- data string -
- port int? - Service port (SRV only)
- priority int? - Record priority (MX and SRV only)
- protocol string? - Service protocol (SRV only)
- 'service string? - Service type (SRV only)
- ttl int? -
- weight int? - Record weight (SRV only)
godaddy.domains: Domain![](/images/permalink.svg)
Fields
- id decimal? -
godaddy.domains: DomainAvailableBulk![](/images/permalink.svg)
Fields
- domains DomainAvailableResponse[] - Domain available response array
godaddy.domains: DomainAvailableBulkMixed![](/images/permalink.svg)
Fields
- domains DomainAvailableResponse[] - Domain available response array
- errors DomainAvailableError[]? - Errors encountered while performing a domain available check
godaddy.domains: DomainAvailableError![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- domain string - Domain name
- message string? - Human-readable, English description of the error
- path string - <ul> <li style='margin-left: 12px;'>JSONPath referring to a field containing an error</li> <strong style='margin-left: 12px;'>OR</strong> <li style='margin-left: 12px;'>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li> </ul>
- status int - HTTP status code that would return for a single check
godaddy.domains: DomainAvailableResponse![](/images/permalink.svg)
Fields
- available boolean - Whether or not the domain name is available
- currency string(default "USD") - Currency in which the
price
is listed. Only returned if tld is offered
- definitive boolean - Whether or not the
available
answer has been definitively verified with the registry
- domain string - Domain name
- period int? - Number of years included in the price. Only returned if tld is offered
- price int? - Price of the domain excluding taxes or fees. Only returned if tld is offered
godaddy.domains: DomainContacts![](/images/permalink.svg)
Fields
- contactAdmin Contact? -
- contactBilling Contact? -
- contactRegistrant Contact -
- contactTech Contact? -
godaddy.domains: DomainDetail![](/images/permalink.svg)
Fields
- authCode string - Authorization code for transferring the Domain
- contactAdmin Contact -
- contactBilling Contact -
- contactRegistrant Contact -
- contactTech Contact -
- createdAt string - Date and time when this domain was created
- deletedAt string? - Date and time when this domain was deleted
- transferAwayEligibleAt string? - Date and time when this domain is eligible to transfer
- domain string - Name of the domain
- domainId decimal - Unique identifier for this Domain
- expirationProtected boolean - Whether or not the domain is protected from expiration
- expires string? - Date and time when this domain will expire
- exposeWhois boolean? - Whether or not the domain contact details should be shown in the WHOIS
- holdRegistrar boolean - Whether or not the domain is on-hold by the registrar
- locked boolean - Whether or not the domain is locked to prevent transfers
- nameServers string[] - Fully-qualified domain names for DNS servers
- privacy boolean - Whether or not the domain has privacy protection
- renewAuto boolean - Whether or not the domain is configured to automatically renew
- renewDeadline string - Date the domain must renew on
- status string - Processing status of the domain<br/><ul> <li><strong style='margin-left: 12px;'>ACTIVE</strong> - All is well</li> <li><strong style='margin-left: 12px;'>AWAITING*</strong> - System is waiting for the end-user to complete an action</li> <li><strong style='margin-left: 12px;'>CANCELLED*</strong> - Domain has been cancelled, and may or may not be reclaimable</li> <li><strong style='margin-left: 12px;'>CONFISCATED</strong> - Domain has been confiscated, usually for abuse, chargeback, or fraud</li> <li><strong style='margin-left: 12px;'>DISABLED*</strong> - Domain has been disabled</li> <li><strong style='margin-left: 12px;'>EXCLUDED*</strong> - Domain has been excluded from Firehose registration</li> <li><strong style='margin-left: 12px;'>EXPIRED*</strong> - Domain has expired</li> <li><strong style='margin-left: 12px;'>FAILED*</strong> - Domain has failed a required action, and the system is no longer retrying</li> <li><strong style='margin-left: 12px;'>HELD*</strong> - Domain has been placed on hold, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>LOCKED*</strong> - Domain has been locked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>PARKED*</strong> - Domain has been parked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>PENDING*</strong> - Domain is working its way through an automated workflow</li> <li><strong style='margin-left: 12px;'>RESERVED*</strong> - Domain is reserved, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>REVERTED</strong> - Domain has been reverted, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>SUSPENDED*</strong> - Domain has been suspended, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>TRANSFERRED*</strong> - Domain has been transferred out</li> <li><strong style='margin-left: 12px;'>UNKNOWN</strong> - Domain is in an unknown state</li> <li><strong style='margin-left: 12px;'>UNLOCKED*</strong> - Domain has been unlocked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>UNPARKED*</strong> - Domain has been unparked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>UPDATED*</strong> - Domain ownership has been transferred to another account</li> </ul>
- subaccountId string? - Reseller subaccount shopperid who can manage the domain
- transferProtected boolean - Whether or not the domain is protected from transfer
- verifications VerificationsDomain? -
godaddy.domains: DomainForwarding![](/images/permalink.svg)
Fields
- fqdn string - The fqdn (domain or sub domain) to forward (ex somedomain.com or sub.somedomain.com)
- 'type string - The type of fowarding to implement<br/><ul><li><strong style='margin-left: 12px;'>MASKED</strong> - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.</li><li><strong style='margin-left: 12px;'>REDIRECT_PERMANENT*</strong> - Redirects to the url you specified in the forwardTo field using a
301 Moved Permanently
HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.</li><li><strong style='margin-left: 12px;'>REDIRECT_TEMPORARY</strong> - Redirects to the url you specified in the forwardTo field using a302 Found
HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.</li></ul>
- url string - Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)
- mask DomainForwardingMask? -
godaddy.domains: DomainForwardingCreate![](/images/permalink.svg)
Fields
- 'type string - The type of fowarding to implement<br/><ul><li><strong style='margin-left: 12px;'>MASKED</strong> - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.</li><li><strong style='margin-left: 12px;'>REDIRECT_PERMANENT*</strong> - Redirects to the url you specified in the forwardTo field using a
301 Moved Permanently
HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.</li><li><strong style='margin-left: 12px;'>REDIRECT_TEMPORARY</strong> - Redirects to the url you specified in the forwardTo field using a302 Found
HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.</li></ul>
- url string - Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)
- mask DomainForwardingMask? -
godaddy.domains: DomainForwardingMask![](/images/permalink.svg)
Fields
- title string? - Displays at the top of the browser window and in search results.
- description string? - A short description of your website to display in search engine results.
- keywords string? - A list of comma-separated keywords that describes the content and purpose of your website.
godaddy.domains: DomainPurchase![](/images/permalink.svg)
Fields
- consent Consent -
- contactAdmin Contact? -
- contactBilling Contact? -
- contactRegistrant Contact? -
- contactTech Contact? -
- domain string - For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked
- nameServers string[]? -
- period int? -
- privacy boolean(default false) -
- renewAuto boolean(default true) -
godaddy.domains: DomainPurchaseResponse![](/images/permalink.svg)
Fields
- currency string(default "USD") - Currency in which the
total
is listed
- itemCount int - Number items included in the order
- orderId int - Unique identifier of the order processed to purchase the domain
- total int - Total cost of the domain and any selected add-ons
godaddy.domains: DomainRenew![](/images/permalink.svg)
Fields
- period int? - Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to
period
specified during original purchase
godaddy.domains: DomainsContactsBulk![](/images/permalink.svg)
Fields
- contactAdmin Contact? -
- contactBilling Contact? -
- contactPresence Contact? -
- contactRegistrant Contact? -
- contactTech Contact? -
- domains string[] - An array of domain names to be validated against. Alternatively, you can specify the extracted tlds. However, full domain names are required if the tld is
uk
- entityType string? - Canadian Presence Requirement (CA)
godaddy.domains: DomainSuggestion![](/images/permalink.svg)
Fields
- domain string - Suggested domain name
godaddy.domains: DomainSummary![](/images/permalink.svg)
Fields
- authCode string? - Authorization code for transferring the Domain
- contactAdmin Contact? -
- contactBilling Contact? -
- contactRegistrant Contact -
- contactTech Contact? -
- createdAt string - Date and time when this domain was created
- deletedAt string? - Date and time when this domain was deleted
- transferAwayEligibleAt string? - Date and time when this domain is eligible to transfer
- domain string - Name of the domain
- domainId decimal - Unique identifier for this Domain
- expirationProtected boolean - Whether or not the domain is protected from expiration
- expires string? - Date and time when this domain will expire
- exposeWhois boolean? - Whether or not the domain contact details should be shown in the WHOIS
- holdRegistrar boolean - Whether or not the domain is on-hold by the registrar
- locked boolean - Whether or not the domain is locked to prevent transfers
- nameServers string[]? - Fully-qualified domain names for DNS servers
- privacy boolean - Whether or not the domain has privacy protection
- renewAuto boolean - Whether or not the domain is configured to automatically renew
- renewDeadline string - Date the domain must renew on
- renewable boolean? - Whether or not the domain is eligble for renewal based on status
- status string - Processing status of the domain<br/><ul> <li><strong style='margin-left: 12px;'>ACTIVE</strong> - All is well</li> <li><strong style='margin-left: 12px;'>AWAITING*</strong> - System is waiting for the end-user to complete an action</li> <li><strong style='margin-left: 12px;'>CANCELLED*</strong> - Domain has been cancelled, and may or may not be reclaimable</li> <li><strong style='margin-left: 12px;'>CONFISCATED</strong> - Domain has been confiscated, usually for abuse, chargeback, or fraud</li> <li><strong style='margin-left: 12px;'>DISABLED*</strong> - Domain has been disabled</li> <li><strong style='margin-left: 12px;'>EXCLUDED*</strong> - Domain has been excluded from Firehose registration</li> <li><strong style='margin-left: 12px;'>EXPIRED*</strong> - Domain has expired</li> <li><strong style='margin-left: 12px;'>FAILED*</strong> - Domain has failed a required action, and the system is no longer retrying</li> <li><strong style='margin-left: 12px;'>HELD*</strong> - Domain has been placed on hold, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>LOCKED*</strong> - Domain has been locked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>PARKED*</strong> - Domain has been parked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>PENDING*</strong> - Domain is working its way through an automated workflow</li> <li><strong style='margin-left: 12px;'>RESERVED*</strong> - Domain is reserved, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>REVERTED</strong> - Domain has been reverted, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>SUSPENDED*</strong> - Domain has been suspended, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>TRANSFERRED*</strong> - Domain has been transferred out</li> <li><strong style='margin-left: 12px;'>UNKNOWN</strong> - Domain is in an unknown state</li> <li><strong style='margin-left: 12px;'>UNLOCKED*</strong> - Domain has been unlocked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>UNPARKED*</strong> - Domain has been unparked, and likely requires intervention from Support</li> <li><strong style='margin-left: 12px;'>UPDATED*</strong> - Domain ownership has been transferred to another account</li> </ul>
- transferProtected boolean - Whether or not the domain is protected from transfer
godaddy.domains: DomainTransferIn![](/images/permalink.svg)
Fields
- authCode string - Authorization code from registrar for transferring a domain
- consent Consent -
- period int? - Can be more than 1 but no more than 10 years total including current registration length
- privacy boolean(default false) - Whether or not privacy has been requested
- renewAuto boolean(default true) - Whether or not the domain should be configured to automatically renew
- contactAdmin Contact? -
- contactBilling Contact? -
- contactRegistrant Contact? -
- contactTech Contact? -
godaddy.domains: DomainUpdate![](/images/permalink.svg)
Fields
- locked boolean? - Whether or not the domain should be locked to prevent transfers
- nameServers record {}[]? - Fully-qualified domain names for Name Servers to associate with the domain
- renewAuto boolean? - Whether or not the domain should be configured to automatically renew
- subaccountId string? - Reseller subaccount shopperid who can manage the domain
- exposeWhois boolean? - Whether or not the domain contact details should be shown in the WHOIS
- consent ConsentDomainUpdate? -
godaddy.domains: Error![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorField[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
godaddy.domains: ErrorDomainContactsValidate![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorFieldDomainContactsValidate[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
- stack string[]? - Stack trace indicating where the error occurred.<br/>NOTE: This attribute <strong>MAY</strong> be included for Development and Test environments. However, it <strong>MUST NOT</strong> be exposed from OTE nor Production systems
godaddy.domains: ErrorField![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- message string? - Human-readable, English description of the problem with the contents of the field
- path string - <ul> <li style='margin-left: 12px;'>JSONPath referring to a field containing an error</li> <strong style='margin-left: 12px;'>OR</strong> <li style='margin-left: 12px;'>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li> </ul>
- pathRelated string? - JSONPath referring to a field containing an error, which is referenced by
path
godaddy.domains: ErrorFieldDomainContactsValidate![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- domains string[] - An array of domain names the error is for. If tlds are specified in the request,
domains
will contain tlds. For example, ifdomains
in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of thefields
in response will have ["test1.com", "net"] asdomains
- message string? - Human-readable, English description of the problem with the contents of the field
- path string -
- JSONPath referring to the field within the data containing an error<br/>or<br/>2) JSONPath referring to an object containing an error
- pathRelated string? - JSONPath referring to the field on the object referenced by
path
containing an error
godaddy.domains: ErrorLimit![](/images/permalink.svg)
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields ErrorField[]? - List of the specific fields, and the errors found with their contents
- message string? - Human-readable, English description of the error
- retryAfterSec int - Number of seconds to wait before attempting a similar request
godaddy.domains: JsonDataType![](/images/permalink.svg)
Fields
- format string? -
- pattern string? -
- 'type string -
godaddy.domains: JsonProperty![](/images/permalink.svg)
Fields
- defaultValue string? -
- format string? -
- items record {}? -
- maxItems int? -
- maximum int? -
- minItems int? -
- minimum int? -
- pattern string? -
- required boolean -
- 'type string -
godaddy.domains: JsonSchema![](/images/permalink.svg)
Fields
- id string -
- models record {} -
- properties record {} -
- required string[] -
godaddy.domains: LegalAgreement![](/images/permalink.svg)
Fields
- agreementKey string - Unique identifier for the legal agreement
- content string - Contents of the legal agreement, suitable for embedding
- title string - Title of the legal agreement
- url string? - URL to a page containing the legal agreement
godaddy.domains: PrivacyPurchase![](/images/permalink.svg)
Fields
- consent Consent -
godaddy.domains: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
godaddy.domains: RealNameValidation![](/images/permalink.svg)
Fields
- status string? -
godaddy.domains: TldSummary![](/images/permalink.svg)
Fields
- name string - Name of the top-level domain
- 'type string - Type of the top-level domain
godaddy.domains: VerificationDomainName![](/images/permalink.svg)
Fields
- status string - Status of the domain name verification
godaddy.domains: VerificationRealName![](/images/permalink.svg)
Fields
- status string - Status of the real name verification<br/><ul> <li><strong style='margin-left: 12px;'>APPROVED</strong> - All is well</li> <li><strong style='margin-left: 12px;'>PENDING</strong> - Real name verification is working its way through the workflow</li> <li><strong style='margin-left: 12px;'>REJECTED_DOCUMENT_OUTDATED</strong> - Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification</li> <li><strong style='margin-left: 12px;'>REJECTED_EXPIRED_BUSINESS_LICENSE</strong> - Business license is expired</li> <li><strong style='margin-left: 12px;'>REJECTED_EXPIRED_ORGANIZATION_CODE</strong> - Organization code certificate number has expired</li> <li><strong style='margin-left: 12px;'>REJECTED_ILLEGIBLE_DOCUMENT_NAME</strong> - There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification</li> <li><strong style='margin-left: 12px;'>REJECTED_ILLEGIBLE_IDENTIFICATION</strong> - Registrant identification is not clear. Upload a better image to retry</li> <li><strong style='margin-left: 12px;'>REJECTED_INCOMPLETE_IDENTIFICATION</strong> - Registrant identification is incomplete</li> <li><strong style='margin-left: 12px;'>REJECTED_INCOMPLETE_REGISTRATION_LETTER</strong> - Registration letter is incomplete</li> <li><strong style='margin-left: 12px;'>REJECTED_INCONSISTENT_IDENTITY_CARD</strong> - Provided identity card is inconsistent with the identity card on record</li> <li><strong style='margin-left: 12px;'>REJECTED_INCONSISTENT_ORGANIZATION_CODE</strong> - Provided organization information is inconsistent with the results obtained using the submitted organization code</li> <li><strong style='margin-left: 12px;'>REJECTED_INCONSISTENT_REGISTRANT_NAME</strong> - Name on the registrant identification does not match the name in the system</li> <li><strong style='margin-left: 12px;'>REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE</strong> - Your document contains an invalid business license or organization code certificate number</li> <li><strong style='margin-left: 12px;'>REJECTED_INVALID_DOCUMENT</strong> - Document is invalid. Please upload another document to retry real name verification</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_BUSINESS_ID</strong> - Business id does not match the business id in the document</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_BUSINESS_NAME</strong> - Business name does not match the business name in the document</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_DOCUMENT_ID</strong> - Document id does not match the id in the document</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_DOCUMENT_NAME</strong> - Document name does not match the name in the document</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_DOCUMENT_TYPE</strong> - Document type does not match the document</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_REGISTRANT_INFO</strong> - The information provided for the registrant does not match the document</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_REGISTRANT_LOCALITY</strong> - Registrant region is overseas, but a local identity document was provided</li> <li><strong style='margin-left: 12px;'>REJECTED_MISMATCH_REGISTRANT_NAME</strong> - Registrant name has been changed, so the request must be resubmitted</li> <li><strong style='margin-left: 12px;'>REJECTED_UNABLE_TO_OPEN</strong> - Registrant identification could not be opened. Please upload the document again to retry real name verification</li> <li><strong style='margin-left: 12px;'>REJECTED_UNABLE_TO_VERIFY</strong> - Unable to initiate verification. Please upload the document again to retry real name verification</li> <li><strong style='margin-left: 12px;'>REJECTED_UNKNOWN_ERROR</strong> - Document was rejected due to an unknown error. For more information, contact customer support</li> <li><strong style='margin-left: 12px;'>UNABLE_TO_RETRIEVE_STATUS</strong> - Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support</li> </ul>
godaddy.domains: VerificationsDomain![](/images/permalink.svg)
Fields
- domainName VerificationDomainName? -
- realName VerificationRealName? -
Import
import ballerinax/godaddy.domains;
Metadata
Released date: over 1 year ago
Version: 1.5.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Website & App Building/Website Builders
Cost/Paid
Contributors