registrar
Check domain
Changed onChecks a domain name for availability.
get/{account}/registrar/domains/{domain}/check
Request
- Base URLhttps://api.dnsimple.com/v2
- Auth
- HTTP basic
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
accountinteger required
The account id
domainstring required
The domain name or id
Response
The check was successfully executed. Check the result data to determine if it is available for registration. If the domain is premium, please check the premium price before trying to register, renew, transfer.
Example response
{
"data": {
"domain": "ruby.codes",
"available": true,
"premium": true,
"trustee": true
}
}Changes
- breaking
removed the required property
/from the response with the status - info
added the required property
/to the response with the status
- breaking
- info
added the required property
/to the response with the status
- info