Domains-domainName:GET
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision) |
Mike.robski (Talk | contribs) (Update to the response when the domain name is available. In Staging on 4/1/13. In production on 4/10/13.) |
||
| Line 15: | Line 15: | ||
;200 OK | ;200 OK | ||
| − | : Domain is registered and does not exist in ServicePlex. The 'available' result will | + | : Domain is either registered and does not exist in ServicePlex, or available. The 'available' result will be 'false' if the domain is registered (in this case and the domain can be presented as already taken and perhaps transferable to ServicePlex) and 'true' if the name is available. |
;203 Non Authoritative | ;203 Non Authoritative | ||
| Line 22: | Line 22: | ||
;400 Bad Request | ;400 Bad Request | ||
: The domain name is not valid. | : The domain name is not valid. | ||
| − | |||
| − | |||
| − | |||
;412 Unauthorized | ;412 Unauthorized | ||
Revision as of 12:06, 27 March 2013
GET /domains/{domainName}
Performs domain availability check.
Contents |
Request
GET /domains/{domainName}
Parameters
- domainName - string
- The valid domain name to check including only the labels that are appropriate for the valid registration of a domain name at the registry. IE: example.com is a valid domain name that could be or is already registered at the registry. Whereas http://www.example.com or www.example.com are not. If the domain name is invalid, or is otherwise not registerable such as for a non-existent or non-supported TLD, an error will be returned. Domain names are case insensitive.
Response
Status Code
An HTTP response code value indicating ancillary information about the domain availability. See notes below for the meaning of the response code. Check the 'available' value to determine if the given domain name is available at the registry.
- 200 OK
- Domain is either registered and does not exist in ServicePlex, or available. The 'available' result will be 'false' if the domain is registered (in this case and the domain can be presented as already taken and perhaps transferable to ServicePlex) and 'true' if the name is available.
- 203 Non Authoritative
- Domain is already registered in ServicePlex. Check the 'available' result to see if the domain exists at the registry already. For example, a domain may be pending provisioning and therefore it already exists in ServicePlex and so is not available for registration even if the 'available' value is 'true'
- 400 Bad Request
- The domain name is not valid.
- 412 Unauthorized
- Domain is not permitted for registration in ServicePlex. Check the 'available' value to see if the domain is registered at the registry. A domain might not be permitted if it is in a restricted list of domain names that are prevented from being registered in ServicePlex. For example buy-olympic-tickets.com might be available but it is restricted. Special privileges are required to register restricted domains.
Response Body
{
"available": "{available}",
"name": "{domainName}"
}
Parameters
- available - boolean
- Indicates if the domain is available for registration true, or if the domain is already registered and subsequently not available for registration false. The value of 'available' is determined by checking the registry to see if a record of the domain exists or not, independent of the status or rules for registering the domain in ServicePlex.
- domainName - string
- The domain name that was supplied in the GET request.
See also
