available
Creates, updates, deletes, gets or lists an available
resource.
Overview
Name | available |
Type | Resource |
Id | godaddy.domains.available |
Fields
The following fields are returned by SELECT
queries:
- available
Request was successful
Name | Datatype | Description |
---|---|---|
available | boolean | Whether or not the domain name is available |
currency | string (iso-currency-code) | Currency in which the price is listed. Only returned if tld is offered (default: USD) |
definitive | boolean | Whether or not the available answer has been definitively verified with the registry |
domain | string | Domain name |
period | integer (integer-positive) | Number of years included in the price. Only returned if tld is offered |
price | integer (currency-micro-unit) | Price of the domain excluding taxes or fees. Only returned if tld is offered |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
available | select | domain | checkType , forTransfer | Determine whether or not the specified domain is available for purchase |
available_bulk | exec | checkType | Determine whether or not the specified domains are available for purchase |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
domain | string | Domain name whose availability is to be checked |
checkType | string | Optimize for time ('FAST') or accuracy ('FULL') |
forTransfer | boolean | Whether or not to include domains available for transfer. If set to True, checkType is ignored |
SELECT
examples
- available
Determine whether or not the specified domain is available for purchase
SELECT
available,
currency,
definitive,
domain,
period,
price
FROM godaddy.domains.available
WHERE domain = '{{ domain }}' -- required
AND checkType = '{{ checkType }}'
AND forTransfer = '{{ forTransfer }}'
;
Lifecycle Methods
- available_bulk
Determine whether or not the specified domains are available for purchase
EXEC godaddy.domains.available.available_bulk
@checkType='{{ checkType }}'
;