fn check_domain(domain: string)
Check domain
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn get_domain_prices(domain: string)
Get prices for a domain
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn register_domain(domain: string, registrant_id: number, whois_privacy?: boolean, auto_renew?: boolean, trustee?: boolean, extended_attributes?: record, premium_price?: string, linked_provider?: string)
Billable: Register a domain
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| registrant_id | number | yes | The ID of an existing contact in your account. |
| whois_privacy? | boolean | no | Set to true will attempt to purchase/enable the whois privacy as part of the... |
| auto_renew? | boolean | no | Set to true to enable the auto-renewal of the domain. Default: false. |
| trustee? | boolean | no | Set to true will attempt to purchase/enable trustee service as part of the... |
| extended_attributes? | record | no | Required for TLDs that require extended attributes. |
| premium_price? | string | no | Required as confirmation of the price, only if the domain is premium. |
| linked_provider? | string | no | The nickname of a linked provider to register the domain through. If left... |
fn get_domain_registration(domain: string, domainregistration: union)
Retrieve a domain registration
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| domainregistration | union | yes | The domain registration id |
fn transfer_domain(domain: string, registrant_id: number, auth_code?: string, whois_privacy?: boolean, auto_renew?: boolean, trustee?: boolean, extended_attributes?: record, premium_price?: string)
Billable: Transfer a domain
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| registrant_id | number | yes | The ID of an existing contact in your account. |
| auth_code? | string | no | |
| whois_privacy? | boolean | no | Set to true will attempt to purchase/enable the whois privacy as part of the... |
| auto_renew? | boolean | no | Set to true to enable the auto-renewal of the domain. Default: false. |
| trustee? | boolean | no | Set to true to use a trustee service for the transfer. An extra cost may... |
| extended_attributes? | record | no | Required for TLDs that require extended attributes. |
| premium_price? | string | no | Required as confirmation of the price, only if the domain is premium. |
fn get_domain_transfer(domain: string, domaintransfer: union)
Retrieve a domain transfer
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| domaintransfer | union | yes | The domain transfer id |
fn cancel_domain_transfer(domain: string, domaintransfer: union)
Cancel a domain transfer
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| domaintransfer | union | yes | The domain transfer id |
fn renew_domain(domain: string, period: number, premium_price?: string)
Billable: Renew a domain
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| period | number | yes | |
| premium_price? | string | no | Required as confirmation of the price, only if the domain is premium. |
fn get_domain_renewal(domain: string, domainrenewal: union)
Retrieve a domain renewal
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| domainrenewal | union | yes | The domain renewal id |
fn restore_domain(domain: string, premium_price?: string)
Billable: Restore a domain
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| premium_price? | string | no | Required as confirmation of the price, only if the domain is premium. |
fn get_domain_restore(domain: string, domainrestore: union)
Retrieve a domain restore
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| domainrestore | union | yes | The domain restore id |
fn authorize_domain_transfer_out(domain: string)
Authorize a domain transfer out
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn get_domain_delegation(domain: string)
List domain name servers
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn change_domain_delegation(domain: string, items: array)
Change domain name servers
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| items | array | yes | |
fn change_domain_delegation_to_vanity(domain: string, items: array)
Delegate to vanity name servers
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
| items | array | yes | |
fn change_domain_delegation_from_vanity(domain: string)
De-delegate from vanity name servers
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn get_domain_transfer_lock(domain: string)
Domain transfer lock status
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn enable_domain_transfer_lock(domain: string)
Enable domain transfer lock
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn disable_domain_transfer_lock(domain: string)
Disable domain transfer lock
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn enable_domain_auto_renewal(domain: string)
Enable domain auto-renewal
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn disable_domain_auto_renewal(domain: string)
Disable domain auto-renewal
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn enable_whois_privacy(domain: string)
Billable: Enable WHOIS privacy
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn disable_whois_privacy(domain: string)
Disable WHOIS privacy
| Argument | Type | Required | Description |
|---|
| domain | string | yes | The domain name or id |
fn list_registrant_changes(sort?: enum, state?: enum, domain_id?: string, contact_id?: string)
List registrant changes
| Argument | Type | Required | Description |
|---|
| sort? | enum | no | Sort results. Default sorting is by id. |
| state? | enum | no | Only include results with a state field exactly matching the given string |
| domain_id? | string | no | Only include results with a domain_id field exactly matching the given string |
| contact_id? | string | no | Only include results with a contact_id field exactly matching the given string |
fn create_registrant_change(domain_id: union, contact_id: union, extended_attributes?: record)
Start registrant change
| Argument | Type | Required | Description |
|---|
| domain_id | union | yes | |
| contact_id | union | yes | |
| extended_attributes? | record | no | |
fn check_registrant_change(domain_id: union, contact_id: union)
Check registrant change requirements
| Argument | Type | Required | Description |
|---|
| domain_id | union | yes | |
| contact_id | union | yes | |
fn get_registrant_change(registrantchange: union)
Retrieve a registrant change
| Argument | Type | Required | Description |
|---|
| registrantchange | union | yes | The registrant change id |
fn delete_registrant_change(registrantchange: union)
Cancel a registrant change
| Argument | Type | Required | Description |
|---|
| registrantchange | union | yes | The registrant change id |
Resources
check_domain(infinite)— Check domain
domain_prices(infinite)— Get prices for a domain
register_domain(infinite)— Billable: Register a domain
domain_registration(infinite)— Retrieve a domain registration
transfer_domain(infinite)— Billable: Transfer a domain
domain_transfer(infinite)— Retrieve a domain transfer
cancel_domain_transfer(infinite)— Cancel a domain transfer
renew_domain(infinite)— Billable: Renew a domain
domain_renewal(infinite)— Retrieve a domain renewal
restore_domain(infinite)— Billable: Restore a domain
domain_restore(infinite)— Retrieve a domain restore
authorize_domain_transfer_out(infinite)— Authorize a domain transfer out
domain_delegation(infinite)— List domain name servers
change_domain_delegation(infinite)— Change domain name servers
change_domain_delegation_to_vanity(infinite)— Delegate to vanity name servers
change_domain_delegation_from_vanity(infinite)— De-delegate from vanity name servers
domain_transfer_lock(infinite)— Domain transfer lock status
enable_domain_transfer_lock(infinite)— Enable domain transfer lock
disable_domain_transfer_lock(infinite)— Disable domain transfer lock
enable_domain_auto_renewal(infinite)— Enable domain auto-renewal
disable_domain_auto_renewal(infinite)— Disable domain auto-renewal
enable_whois_privacy(infinite)— Billable: Enable WHOIS privacy
disable_whois_privacy(infinite)— Disable WHOIS privacy
registrant_changes(infinite)— List registrant changes
registrant_change(infinite)— Start registrant change
check_registrant_change(infinite)— Check registrant change requirements
delete_registrant_change(infinite)— Cancel a registrant change