Hostway API Documentation - User contributions [en]

Server Response Codes

2015-03-27T04:00:05Z

Philip.rittscher:

Successful Responses
----

; 200 Ok
: The requested action succeeded (completely) and the response body indicates further information.

; 201 Created
: The request has been received and a new object has been created. The response body or headers should indicate a pointer to the objects monitor.

; 202 Accepted
: The request was accepted but has not been completed and should indicate a pointer to the objects monitor. The request may or may not be successfully completed.

; 204 No Content
: The request was accepted and completed and no further information is provided. For example, when an object us updated or deleted and the request is successful.

Redirection
----

; 304 Not Modified
: This is returned on a GET request for objects that support caching and requires a request header for "If-Modified-Since".

; 303 See Other
: Used in some cases during paging to redirect back to the beginning of the paginated result set. For example when requesting page 11 of only 10 pages.

Client Errors
----

; 400 Bad Request
: Request is not valid because of an invalid invalid or missing parameters, or when the request body is badly formatted or does not meet the requirements set for the resources.

; 401 Unauthorized (*)
: Should be returned when the resource requires authentication, and no Authorization header is provided or the Authorization header is invalid due to incorrect credentials.

; 403 Forbidden
: The request was authorized but does not have permission to perform the requested action. For example trying to edit an object owned by another account. Trying to use more resources than the client owns.

; 404 Not Found
: The URI does not lead to a resource, or the requested object, or a related object could not be found.

; 405 Method Not Allowed
: Attempting to call an HTTP method that is not allowed on the given object. For example trying to call POST or PUT on an object that was already created and cannot be modified.

; 406 Not Acceptable (*)
: Used in one case in the DNS API if the request contains data that is not acceptable or valid. Should be returned as a HTTPBadRequest.

; 409 Conflict
: The requested action could not be completed according to the current state of the object. For example attempting to modify a product that is still in pending status..

; 413 Request Entity Too Large
: In rare cases where the request could not be fulfilled because the result would take too many resources. This error should **NOT** be returned for invalid request data that exceeds data length restrictions such as a telephone number with 100 digits. A valid reason for this error may be for example a bulk order that contains 5,000 products.

; 415 Unsupported Media Type
: If the request header indicated a media type that is not supported. Also used when the given media is not in the correct format such as a JSON message body that has syntax errors and cannot be parsed.

Server Errors
----

For any API request the response may be a server error code of the group 5xx. Server errors are not caused by an error in the client request. In many cases retrying the request may solve the issue.

;500 Internal Server Error
:The server encountered an unexpected condition which prevented it from fulfilling the request.

;501 Not Implemented
:The server does not support the functionality required to fulfill the request.

;502 Bad Gateway
:The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

;503 Service Unavailable
:The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

;504 Gateway Timeout
:The server did not receive a timely response from the upstream server or some other auxiliary server it needed to access in attempting to complete the request.

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Common Features]]
[[Category:Hostway API]]

Common Features

2015-03-23T23:22:05Z

Philip.rittscher:

All Hostway APIs support common features for authentication and authorization, pagination, references to related resources, etc.

* [[Authentication]]
* [[Hypermedia]]
* [[Pagination]]
* [[Server Response Codes]]
* [[Filtering]]

[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

{{disqus}}
[[Category:Common Features]]
[[Category:Hostway API]]

Server Error Codes

2015-03-23T23:20:04Z

Philip.rittscher:

Successful Responses
----

; 200 Ok
: The requested action succeeded (completely) and the response body indicates further information.

; 201 Accepted
: The request has been received but has not been completed and the response body should indicate a pointer to the objects monitor. Usually for creating objects asynchronously.

; 202 No Content
: The request was accepted and completed. No further information is provided. For example, deleting a resource.

; 204 Created
: The request was accepted and completed. The response should indicate a pointer to the objects monitor.

Redirection
----

; 304 Not Modified
: This is returned on a GET request for objects that support caching and requires a request header for "If-Modified-Since".

; 303 See Other
: Used in some cases during paging to redirect back to the beginning of the paginated result set. For example when requesting page 11 of only 10 pages.

Client Errors
----

; 400 Bad Request
: Request is not valid because of an invalid URI or invalid or missing parameters.

; 401 Unauthorized (*)
: Should be returned when the request is not properly authorized with the Authorization header. Is also used if the request attempts to access objects or accounts it does not own. Or if the given account subject of the request could not be found. Should be used in relation to the authentication header.

; 403 Forbidden
: The request was authorized but does not have permission to perform the requested action. For example trying to edit an object owned by another account. Trying to use more resources than the client owns.

; 404 Not Found
: The URI does not lead to a resource, or the requested object, or a related object could not be found.

; 405 Method Not Allowed
: Attempting to call an HTTP method that is not allowed on the given object. For example trying to call POST or PUT on an object that was already created and cannot be modified.

; 406 Not Acceptable (*)
: Used in one case in the DNS API if the request contains data that is not acceptable or valid. Should be returned as a HTTPBadRequest.

; 409 Conflict
: The requested action could not be completed according to the current state of the object. For example attempting to modify a product that is still in pending status..

; 413 Request Entity Too Large
: In rare cases where the request could not be fulfilled because the result would take too many resources. This error should **NOT** be returned for invalid request data that exceeds data length restrictions such as a telephone number with 100 digits. A valid reason for this error may be for example a bulk order that contains 5,000 products.

; 415 Unsupported Media Type
: If the request header indicated a media type that is not supported. Also used when the given media is not in the correct format such as a JSON message body that has syntax errors and cannot be parsed.

Server Errors
----

For any API request the response may be a server error code of the group 5xx. Server errors are not caused by an error in the client request. In many cases retrying the request may solve the issue.

;500 Internal Server Error
:The server encountered an unexpected condition which prevented it from fulfilling the request.

;501 Not Implemented
:The server does not support the functionality required to fulfill the request.

;502 Bad Gateway
:The server received an invalid response from the upstream server it accessed in attempting to fulfill the request.

;503 Service Unavailable
:The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

;504 Gateway Timeout
:The server did not receive a timely response from the upstream server or some other auxiliary server it needed to access in attempting to complete the request.

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Common Features]]
[[Category:Hostway API]]

Accounts-accountNumber-web-:GET

2015-03-17T18:50:31Z

Philip.rittscher:

= GET /accounts/{accountNumber}/web =
Returns a list of websites.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the domain name alias belong
; filterStatus
: The status of the webhosting product (optional), [pending, open, suspended, close_pending, closed ]
; filterCreatedAfter
: yyyy-mm-dd (optional)
;page
: page number (optional)
;pageSize
: number of items per page (optional)

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"totalCount": {totalCount},
"list": [
{
"status": "{status}",
"createDate": "{createDate}",
"links": [
{
"href": "https://{apiServer}/accounts/{accountId}/web/{domainName}",
"rel": "self"
}
],
"domainName": "{domainName}"
}
],
"links": [
{
"href": "https://{apiServer}/accounts/{accountId}/web/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====

:; links - ''list''
:: [[Hypermedia|Hypermedia]] for this resource

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name or the domain name alias do not exist for the account

== Examples ==

=== Successful retrieving websites ===
'''Request'''
<nowiki>
GET /accounts/acct411359/web?page=12&pageSize=2
</nowiki>

'''Response'''

In this example response, the last two items of the list of 24 matches are returned. The 'next and 'last' navigation links are not provided since this is the last page of the results. For the last item in the list the status is set to 'closed' and therefore there are no links for the product.
<nowiki>
{
'totalCount' => 24,
'links' => [
{
'rel' => 'self',
'href' => 'https://{apiServer}/accounts/acct411359/web?page=12&pageSize=2'
},
{
'rel' => 'first',
'href' => 'https://{apiServer}/accounts/acct411359/web?page=1&pageSize=2'
},
{
'rel' => 'previous',
'href' => 'https://{apiServer}/accounts/acct411359/web?page=11&pageSize=2'
}
],
'list' => [
{
'createDate' => '2015-03-06',
'status' => 'open',
'domainName' => 'ng-test-website2-20150306-1200.com',
'links' => [
{
'rel' => 'self',
'href' => 'http://{apiServer}/accounts/acct411359/web/ng-test-website2-20150306-1200.com'
}
]
},
{
'createDate' => '2015-03-06',
'status' => 'closed',
'domainName' => 'ng-test-website3-20150306-1200.com'
}
]
}
</nowiki>

=== Successful retrieving websites with filter by closed status ===
'''Request'''
<nowiki>
GET /accounts/acct411359/web?page=1&pageSize=100&status=closed
</nowiki>

'''Response'''
<nowiki>

{
"totalCount": 1,
"list": [
{
"status": "closed",
"createDate": "2015-03-06",
"uri": "http://cp-rest01-van.vancouver.hostway:8182/accounts/acct411359/web/ng-test-website3-20150306-1200.com",
"domainName": "ng-test-website3-20150306-1200.com"
}
],
"links": [
{
"href": "http://cp-rest01-van.vancouver.hostway:8182/accounts/acct411359/web?page=1&pageSize=100&status=closed",
"rel": "self"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Web API]]

Accounts-accountNumber-web-domainName-ftp-FtpUsername:GET

2015-03-17T18:40:20Z

Philip.rittscher: Created page with "= GET /accounts/{accountNumber}/web/{domainName}/ftp/{username} = Returns details of an ftp account. __TOC__ == Request == <code>GET /accounts/{accountNumber}/web/{domainNam..."

= GET /accounts/{accountNumber}/web/{domainName}/ftp/{username} =
Returns details of an ftp account.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/ftp/{username}</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account of the web site owner
; domainName - ''string''
: The domain name of the website
; username - ''string''
: The username of the ftp account

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"username": "{username}",
"status": "{status}",
"domain": "{domain}",
"type": "{ftpAccountType}",
"server": "{server}"
}
</nowiki>

=== Response parameters ====

; username - ''string''
: The username of the ftp account

; status - ''string''
: Status of the ftp account (needs explanation)

; domain - ''string''
: The domain name of the web site

; ftpAccountType - ''string''
: The type of the ftp account, one of "www.account.master", "www.account.ftp", "www.account.subftp". There is always one master account which can't be deleted. There are also regular ftp accounts and sub dir ftp accounts associated with a sub folder (currently folder name is the same as the username).

; server - ''string''
: The ftp server name for the ftp account.

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The ftp account doesn't exist

== Examples ==

=== Getting details for an ftp accounts ===
'''Request'''
<nowiki>
GET /accounts/acct411359/web/ng-test-website1-20150305-0734.us/ftp/testftp1
</nowiki>

'''Response'''
<nowiki>
{
"username": "testftp1",
"status": "1",
"domain": "ng-test-website1-20150305-0734.us",
"type": "www.account.ftp",
"server": "pegasus-vip.bhp.staging.chicago.hostway"
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Web API]]

Accounts-accountNumber-web-domainName-ftps-FtpUsername:GET

2015-03-17T18:39:41Z

Philip.rittscher:

Accounts-accountNumber-web-domainName-ftp:GET

2015-03-17T18:38:58Z

Philip.rittscher: Created page with "= GET /accounts/{accountNumber}/web/{domainName}/ftp = Returns a list of ftp accounts for the website. __TOC__ == Request == <code>GET /accounts/{accountNumber}/web/{domainN..."

= GET /accounts/{accountNumber}/web/{domainName}/ftp =
Returns a list of ftp accounts for the website.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/ftp</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account of the web site owner
; domainName - ''string''
: The domain name of the website

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"users":
[
{
"username": "{username}",
"type": "{ftpAccountType}"
},
...
]
}
</nowiki>

=== Response parameters ====

; username - ''string''
: The username of the ftp account
; ftpAccountType - ''string''
: The type of the ftp account, one of "www.account.master", "www.account.ftp", "www.account.subftp". There is always one master account which can't be deleted. There are also regular ftp accounts and sub dir ftp accounts associated with a sub folder (currently folder name is the same as the username).

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation

; 403 Forbidden
: The authenticated user is not allowed to access this resource

== Examples ==

=== Listing the ftp accounts for a website ===
'''Request'''
<nowiki>
GET /accounts/acct411359/web/ng-test-website1-20150305-0734.us/ftp
</nowiki>

'''Response'''
<nowiki>
{
"users":
[
{
"username": "ng-test-website1-35",
"type": "www.account.master"
},
{
"username": "testftp1",
"type": "www.account.ftp"
},
{
"username": "testsubftp1",
"type": "www.account.subftp"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Web API]]

Accounts-accountNumber-web-domainName-ftps:GET

2015-03-17T18:38:17Z

Philip.rittscher: changed from FTPS to FTP

Accounts-accountNumber-web-domainName:GET

2015-03-17T18:05:20Z

Philip.rittscher: /* Successful retrieving websites */

= GET /accounts/{accountNumber}/web/{domainName} =
Returns detail information for a {domainName} website.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the domain name alias belong

; domainName - ''string''
: The domainName associated with the webhosting

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>

{
"planName": "{planName}",
"domainName": "{domainName}",
"status": "{status}",
"tempDomain": "{tempDomain}",
"users": [
{
"username": "{username}",
"type": "{type}"
}
],
"diskUsage": "{diskUsage}",
"diskHardQuota": "{diskHardQuota}",
"diskSoftQuota": "diskSoftQuota",
"filesUsage": "{filesUsage}",
"filesHardQuota": "{filesHardQuota}",
"filesSoftQuota": "{filesSoftQuota}",
"webstatsUrl": "{webStatsUrl}",
"adsEnabled": "{adsEnabled}",
"sslServer": "{sslServer}",
"createDate": "{createDate}",
"webDirectory": "{webDirectory}",
"homeDirectory": "{homeDirectory}",
"links" => [
{
"rel" => "self",
"href" => "https://{apiServer}/accounts/{accountId}/web/{domainName}"
}
]
}
</nowiki>

==== Parameters ====

; planName - ''string''
: The name of the web hosting plan.

; domainName - ''string''
: The name of the domain name associated with the web hosting plan.

; status - ''string''
: The product status may be one of 'pending, 'open', 'closed'

; tempDomain - ''string''
: This is a temporary host name that can be used to access the site before the DNS is resolving for the domainName associated to the site. Typically DNS for the temporary domain will resolve sooner than a newly registered domain or before a domain transfer is complete.

; users - ''list''
: The list of FTP usernames that are assigned to the site. Includes
::* username - ''string''
::: The FTP username
::* type - ''string''
::: The FTP user type may be one of either:
:::* 'www.account.master' - a website account should always include one user of this type
:::* 'www.account.ftp'
:::* 'www.account.subftp'

; diskUsage - ''integer''
: This represents the number of bytes in use by this website.

; diskHardQuota - ''integer''
: The absolute maximum limit of the number of bytes that can be allocated to the disk for this website.

; diskSoftQuota - ''integer''
: The limit on the number of bytes that can be allocated to the disk for this website plan. If diskUsage exceeds diskSoftUsage for a predetermined amount of time, no further data may be written to the website.

; filesUsage - ''integer''
: The current number of files that exist in the website directory structure.

; filesHardQuota - ''integer''
: This is the absolute maximum number of files that can be added to a website directory structure.

; filesSoftQuota
: The number of files allowed according to the website plan. If the softFilesQuota is exceeded for a predetermined amount of time, no further files may be written to the website.

; webStatsUrl - ''string''
: This is a URL to the statistics pages that are generated as part of the stats package enabled for a web site.

; adsEnabled - ''integer''
: Value of 1 or 0 indicating whether ads are enabled for autogenerated default error pages such as 404 - Page Not Found and 500 - Internal Server Error.

; sslServer - ''string''
: This is a hostname for a default SSL site that can be used for a website for testing purposes.

; createDate - ''date''
: Date that the website was created.

; homeDirectory - ''string''
The home directory is the location relative to the main FTP login that contains the website content.

; links - ''list''
A list of the links relevant to this website

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name or the domain name alias do not exist for the account

== Examples ==

=== Successful retrieving websites ===
'''Request'''
<nowiki>
GET /accounts/acct411359/web/ng-test-website3-20150306-1200.com
</nowiki>

'''Response'''
<nowiki>

{
'planName' => 'Linux WebStart',
'domainName' => 'ng-test-website3-20150306-1200.com',
'tempDomain' => 'ng-test-website3-20150306-1200com.temptld.ote.hostway',
'filesUsage' => '27',
'sslServer' => 'id108240.securedata.net',
'diskUsage' => '0',
'status' => 'open',
'filesHardQuota' => '20000',
'users' => [
{
'type' => 'www.account.master',
'username' => 'ng-test-website3-38'
}
],
'diskSoftQuota' => '4500',
'webstatsUrl' => 'http://www.ng-test-website3-20150306-1200.com/stats',
'createDate' => '2015-03-06',
'adsEnabled' => '1',
'links' => [
{
'rel' => 'self',
'href' => 'https://{apiServer}/accounts/acct411359/web/ng-test-website3-20150306-1200.com'
}
],
'homeDirectory' => '/web',
'diskHardQuota' => '5000',
'filesSoftQuota' => '18000'
};
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Web API]]

Domains-domainName-contactverification:GET

2014-10-08T05:09:33Z

Philip.rittscher: /* GET /domains/{domainName}/contactverification */

= GET /domains/''{domainName}''/contactverification =
Get the status of the contactverification for {domainName}
Or
Get will send a verification email for {domainName}

*[This page requires more explanatory detail and examples]*

__TOC__
== Request ==
<code>GET /domains/''{domainName}''/contactverification</code>

==== Parameters ====
;action
: The action GET will take.
: info | sendVerificationEmail

=== URI Parameters ===
{{DomainName}}

=== Request Headers ===
None.

=== Request Body ===
None.

== Response ==

=== Status Code ===
;200 OK
: Returns contact verification status when action=info
;204 No Content
: when action=sendVerificationEmail

=== Response Body ===
<nowiki>
{
"verificationStatus":"pending"
}
</nowiki>

=== Response parameters ===
; verificationStatus - ''string''
: "Verified", "Cancelled", "Queued, Pending Verification", "Queue Expired", "Pending Suspension", "Suspended"

== Example getting contact verification status for a domain. ==
'''Request'''
<nowiki>
GET /domains/example.com/contactverification?action=info
</nowiki>

'''Response'''
<nowiki>
200 OK
Content-Type: application/json; charset=UTF-8
{"verificationStatus": "pending"}
</nowiki>

== Example sending contact verification for a domain. ==
'''Request'''
<nowiki>
GET /domains/example.com/contactverification?action=sendVerificationEmail
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Accounts-accountNumber-domains-transfer-domainName:PUT

2014-04-24T00:33:58Z

Philip.rittscher:

= PUT /accounts/''{accountNumber}''/domains/transfers/''{domainName}'' =
A domain name transfer is a long running process that may run into several problems along they way. If a problem occurs, a domain transfer will block for up to 60 days. The reset call is made to retry the transfer based on some change that will remove the impediment to the transfer's progress. Possible reasons that a transfer will block are:
* Domain status at the registry prevented the transfer: for example the domain was locked, or in redemptionPeriod
* Wrong authInfo was supplied and the registry rejected the attempt
* Domain was registered for less that 60 days at the time the transfer was attempted
* The registrar or customer rejected the transfer request (NACK)
* The current authorized contact of the domain failed to respond to the request to authorize the transfer
* The domain was already pending transfer at the registry

__TOC__
== Request ==
<code>PUT /accounts/''{accountNumber}''/domains/transfers/''{domainName}''</code>

=== URI Parameters ===
;accountNumber
: client account number
{{DomainTransfer}}

=== Request Headers ===
Content-type: application/json

=== Request Body ===
<nowiki>
{
'authInfo': '{authInfo}'
}
</nowiki>

=== Parameters ===
;authInfo - string
The authInfo passed in the request body is optional. If a value is passed it must be a valid authInfo string from 6 to 16 characters in length. If no authInfo is passed the previous value will be used. In the case where the previous value was not accepted by the registry, a new authInfo should be supplied or the existing registrar should update the authInfo to the value that was previously used.

== Response ==

=== Status Code ===
;202 OK
: Domain transfer has been reset

;404 Bad Request
: One of the required parameters accountNumber, domainName or authInfo was missing or invalid.

;404 Not Found
: No pending transfer order found for this domain.

;403 Forbidden
: The domain transfer does not belong to the given customer account.

;409 Conflict
: Domain transfer is pending but is not in a state that can be reset. For example, the transfer was successfully sent to the registry and is awaiting a response from the current registrar. Use the call to get domain transfer status to see if the domain may be reset.

;500 Internal Server Error
: An unknown error occurred.

=== Response Body ===
No body.

=== Parameters ===
No response parameters.

== Example of getting transfer status. ==
'''Request'''
<nowiki>
PUT /accounts/acct12345/domains/transfers/test.com

{
'authInfo': 'mySecret'
}
</nowiki>

'''Response'''
<nowiki>
204 OK
</nowiki>

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domain Name Registration

2014-04-23T23:59:45Z

Philip.rittscher:

= Domain Name Registration API =
Public API to manage domain name registration records including domain availability check, domain registration, renewal, transfer, whois editing, name server changes, host record creation, locking, additional features, special; registration attributes, domain security, supported TLDs and more.

__TOC__
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]

== Top level domains ==
=== Get a list of available tlds ===
* [[domains-tlds:GET | GET /domains/tlds]] - Get a list of available tlds.

== Domain Name Availability Check ==
=== Check availability of a domain ===
* [[domains-domainName:GET | GET /domains/{domainName}]] - Check a domain name for availability
=== Name suggestions search (Name Spinner) ===
* [[domains-domainName-namespinner:GET | GET /domains/{domainName}/namespinner]] - Get availability results for suggested names

== Domain Name Transfers ==
=== Check transferability of a domain ===
* [[domains-domainName-transfer:GET | GET /domains/{domainName}/transfer]] - Check a domain name for transferability
=== Get status of pending transfer ===
* [[accounts-accountNumber-domains-transfer-domainName:GET | GET /accounts/{accountNumber}/domains/transfer/{domainName}]] - Check transfer status for a domain
=== Reset/Retry domain transfer ===
* [[accounts-accountNumber-domains-transfer-domainName:PUT | PUT /accounts/{accountNumber}/domains/transfer/{domainName}]] - Reset a domain transfer that is blocked for various reasons

== Ordering domain ==
=== Ordering API ===
* [[OrderingDomain|Ordering Domain]] - Order domain name using the Ordering API
* [[OrderingTransferDomain|Ordering Transfer Domain]] - Order transfer domain name using the Ordering API
=== Order domain shortcut ===
Register
* [[accounts-accountId-domains-domainName:PUT|PUT /accounts/{accountId}/domains/{domainName}]] - Order domain name for an existing account using the "shortcut" command
Transfer
* [[accounts-accountId-transfer-domains-domainNames:PUT|PUT /accounts/{accountId}/domains/{domainName}]] - Order transfer domain name for an existing account using the "shortcut" command

== Domain Name Management ==

=== Search for domains in account ===
* [[accounts-accountNumber-domains:GET | GET /accounts/{accountNumber}/domains]] - Search for domains in client's account.

=== Get domain details ===
* [[domains-domainName-details:GET | GET /domains/{domainName}/details]] - Get information about the given domain name such as creation date, name servers, lock status and whois info.

=== Lock / Unlock ===
* [[domains-domainName-lock:GET | GET /domains/{domainName}/lock]] - Get the current lock status of a domain name
* [[domains-domainName-lock:PUT | PUT /domains/{domainName}/lock]] - Place a lock on a domain name that prevents unauthorized transfer or changes
* [[domains-domainName-lock:DELETE | DELETE /domains/{domainName}/lock]] - Remove a lock on a domain

=== Hold / Unhold ===
* [[domains-domainName-hold:GET | GET /domains/{domainName}/hold]] - Get the current domain hold status.
* [[domains-domainName-hold:PUT | PUT /domains/{domainName}/hold]] - Place a hold on a domain name that prevents the domain from resolving
* [[domains-domainName-hold:DELETE | DELETE /domains/{domainName}/hold]] - Remove a hold on a domain

=== Name Servers ===
* [[domains-domainName-nameservers:GET | GET /domains/{domainName}/nameservers]] - Get the name servers used to serve the DNS of the domain
* [[domains-domainName-nameservers:PUT | PUT /domains/{domainName}/nameservers]] - Change the name servers used to serve the DNS of the domain

=== Whois contacts ===
* [[domains-domainName-contactType:GET|GET /domains/{domainName}/{contactType}]] - Gets the contact info for the specified contact
* [[domains-domainName-contactType:PUT|PUT /domains/{domainName}/{contactType}]] - Changes the contact info of a domain name

=== Domain authorization code ===
* [[domains-domainName-authInfo:GET|GET /domains/{domainName}/authInfo]] - Gets the authorization code (authInfo).
* [[domains-domainName-authInfo:PUT|PUT /domains/{domainName}/authInfo]] - Sets or generates the authorization info

=== Auto-renewal status ===
* [[domains-domainName-autoRenew:GET|GET /domains/{domainName}/autoRenew]] - Gets the current auto-renewal status
* [[domains-domainName-autoRenew:PUT|PUT /domains/{domainName}/autoRenew]] - Sets the auto-renewal status
* [[domains-domainName-autoRenew:OPTIONS|OPTIONS /domains/{domainName}/autoRenew]] - Check whether the auto-renewal status can be set.

=== Domain hosts ===
* [[domains-domainName-hosts:GET|GET /domains/{domainName}/hosts]] - Gets the current hosts
* [[domains-domainName-hosts:PUT|PUT /domains/{domainName}/hosts]] - Replace the hosts
* [[domains-domainName-hosts:POST|POST /domains/{domainName}/hosts]] - Add or update hosts
* [[domains-domainName-hosts:DELETE|DELETE /domains/{domainName}/hosts/{hostName}]] - Delete a host

=== Domain contact verification ===
* [[domains-domainName-contactverification:GET|GET /domains/{domainName}/contactverification]] - Gets the status of the contact verification for {domainName} or Send email contact verification for {domainName}

=== Private registration ===
* [[domains-domainName-privateregistration:GET|GET /domains/{domainName}/privateregistration]] - Gets the privateregistration info for the domain
* [[domains-domainName-privateregistration:POST|POST /domains/{domainName}/privateregistration]] - Update the privateregistration - change forwarding e-mail address, upgrade or downgrade between "full" and "light" version of the privateregistration product.
* [[domains-domainName-privateregistration:DELETE|DELETE /domains/{domainName}/privateregistration]] - Remove the privateregistration

== Renew Domain ==
* [[domains-domainName-renewTerms:GET|GET /domains/{domainName}/renewTerms]] - get available renewal terms and pricing
* [[domains-domainName-renew:POST|POST /domains/{domainName}/renew]] - renew a domain for a specific registration period

== Domain Pricing ==
* [[domains-domainName-prices:GET|GET /domains/{domainName}/prices]] - get domain prices
* [[domains-domainName-prices/register:GET|GET /domains/{domainName}/prices/register]] - get domain register prices
* [[domains-domainName-prices/renew:GET|GET /domains/{domainName}/prices/renew]] - get domain renew prices
* [[domains-domainName-prices/transfer:GET|GET /domains/{domainName}/prices/transfer]] - get domain transfer prices

== Private Registration Availability By TLD ==
* [[domains-domainName-privateregistration-:GET|GET /domains/privateregistration]] - Is private registration available for tld's

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Accounts-accountNumber-domains-domainName-search:GET

2013-10-15T17:06:12Z

Philip.rittscher: /* Example search for a domain product. */

= GET /accounts/''{accountNumber}''/domains/''{domainName}''/search =
Search for domains in client's account. Standard paging parameters can be used.
The result is in standard paging format: list of list of results and pages count.
You can search by name (with wildcard), expired or expiring (within 45 days of
expiration) domains, or specify date range for expiration.

__TOC__
== Request ==
<code>GET /accounts/''{accountNumber}''/domains/''{domainName}''/search</code>

==== Parameters ====
;name
: Domain name or wildcard pattern (optional).
;expired
: true|false (optional)
;expiring
: true|false (optional)
;days
: number of days (optional) to be used in conjunction with expiring or expired. The default value is 45 days, i.e. a domain is considered "expiring" if it expires in 45 days or less.
;expiresBefore
: yyyy-mm-dd (optional)
;expiresAfter
: yyyy-mm-dd (optional)
;page
: page number (optional)
;pageSize
: number of items per page (optional)

=== URI Parameters ===
;accountNumber
: client account number
{{DomainName}}

=== Request Headers ===
None.

=== Request Body ===
None.

== Response ==

=== Status Code ===
;200 OK
: Returns list of domains.

=== Response Body ===
List of list of domains and pages count.

== Example search for a domain product. ==
'''Request'''
<nowiki>
GET /accounts/acct839326/domains/search?page=1&pageSize=10&name=ng-test*&expired=false&expiring=false&expiresAfter=2014-04-11

</nowiki>

'''Response'''
<nowiki>
200 OK
Content-Type: application/json; charset=UTF-8

{
"total_count": 1,
"list":
[
{
"status": "open",
"createDate": "2013-02-02",
"billingCycle": 12,
"name": "ng-test-fitnesse-20130202-0605.com",
"expirationDate": "2018-02-02"
}
],
"links":
[
{
"href": "http://{host:port}/accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test-fitnesse-search-20131010-022746.com&filterActivationDate='2013-10-10'&filterMonthlyCycle=12&filterStatus=open",
"rel": "self"
}
]
}
</nowiki>

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName-renew:POST

2013-06-05T22:24:28Z

Philip.rittscher:

= POST /domains/''{domainName}''/renew =
Renew a domain for a specified registration period.
__TOC__

== Request ==
<code>POST /domains/''{domainName}''/renew</code>

=== URI Parameters ===
; domainName - string
: The domain name to renew. Domain name is case insensitive.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>
; Authorization
: Required.

=== Request Body ===
'''Request Body for renewing a domain'''
<nowiki>
{
"term": "{term}",
"currentExpireDate": "{expireDate}"
}
</nowiki>

==== Request Parameters ====
;term - integer
: Required. The number of years to add to the registration term. This amount must match one of the available cycles for renewing a domain. For example, if the [[pricing|pricing]] call shows that a domain has available cycles of 1 year, 5 and 10 this means a domain may not be renewed for 3 years, since that is not an available term for renewal. A domain cannot be renewed beyond its maximum registration term. Therefore if the max registration term is 10 years and a domain expires in 5 days, it cannot be renewed for 10 years, since this would mean the new term would be 10 years and 5 days into the future. Only a domain that is already expired can be renewed for its max registration term.

; expireDate - date
: The current expiration date of the domain is required to prove that the renewal request is unique and is not a duplicate renewal that has already been processed. If the given expireDate does not match the current expiration date of the domain, the renewal request is rejected. Use [[domains-domainName-details:GET|the domain info command]] to get the expireDate of the domains. The format for the date is yyyy-mm-dd

== Response ==

=== Status Code ===
;201 Accepted
: The domain renewal order has been submitted.

;400 Bad Request
: If the given data is not acceptable. The domain name may be invalid if it includes parts of the URL like 'http://'. If the registration term is not not a supported registration term for the domain, or if the expire date is in an invalid format. This error is also invoked if any of the required parameters are missing from the request.

;403 - Not authorized
: The domain name does not belong in the account of the customer who is attempting to renew the domain. Only the account holder may renew the domain.

;404 - Not found
: The domain name does not exist or is in a closed or suspended state and cannot be renewed.

;409 - Conflict
: When the registration term exceeds the maximum registration period, or the current expiration date supplied in the request does not match the expire date of the domain.

=== Response Body ===
'''Response Body for renewing a domain'''
None
== Example of ordering domain renewal. ==
'''Request'''
<nowiki>
POST /domains/ng-test-fitnesse-shortcut-20130412-0940.com/renew
Content-Type: application/json; charset=UTF-8
Authorization: Basic ...

{
"term": "1",
"currentExpireDate": "2013-09-21"
}
</nowiki>

'''Response'''
<nowiki>
201 Accepted
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName-namespinner:GET

2013-05-16T00:23:56Z

Philip.rittscher:

= GET /domains/''{domainName}''/namespinner =
The NameSpinner command generates domain name suggestions that are similar to the given domain. The results include information on the availability of each suggested domain in different Top Level Domains (TLD). Results can be adjusted by TLD, the number of results to return, the inclusion of hyphens to seperate words, and the use of related terms or phrases. The name spinner can be used to suggest alternative choices for domains when the customers preferred choices are all taken. It is therefore useful to use in conjunction with the standard domain availability check command.

__TOC__

== Request ==
<code>GET /domains/''{domainName}''/namespinner</code>

==== Parameters ====
; domainName
: Required, the domain name, word or search terms for which to get suggestions. The input must include only alphanumeric characters, the 'dot' character, hyphens and spaces. For example the following are valid domainName values "Check my domain", "checkmydomain.com", "check-my-domain". The following are not valid "http://www.checkmydomain.com", "www.checkmydomain.com"

=== URI Parameters ===
; maxResults - ''int''
: Optional, if specified controls the maximum number of suggestions per TLD. The value must be between 1 and 99. The default value is 20. NOTE: the number of results returned may be less than maxResults if there are not enough suggestions to provide based on the search terms.

; useHyphens - ''boolean''
: Optional, if specified controls whether to use hyphens when generating suggestions. Depending on the search terms and the number of results, the useHyphens toggle may or may not have an impact on results. The default is 'false'.

; addRelated - ''boolean''
: Optional, if specified controls whether to use related terms or phrases when generating suggestions. For example if the input includes the words 'HorseTrading' the addRelated parameter might cause a result such as SportHorseTrading, since sport and horse are related. The default is false.

; TLDList - ''string''
: Optional, if specified the list of TLDs may include COM, NET, ORG, INFO, BIZ, CO, PRO, US, CA, ASIA & MOBI. The list is a comma separated list of the desired TLDs to include in the results, and must not include the 'dot' ('.') separator. The default is to include all supported TLDs.

=== Request Headers ===
; Accept
: Allows the client to specify the preferred response content type. Currently supported values:
:: application/json

== Response ==

=== Status Code ===
;200 OK
: Success.

=== Response Body ===
<nowiki>
{"suggestions":
[
{"available": "{available}", "name": "{suggestion}", "tld": "{tld}"}
]
}
</nowiki>

=== Response parameters ===

; available - ''boolean''
: Indicates true or false if the suggested domain name is available for registration for this TLD.

; suggestion - ''string''
: The second level domain name label.

; tld - ''string''
: The TLD associated with this suggestion. The 'name' and 'tld' should be combined to form the complete domain name. For example 'name'.'tld'

== Example Name Spinner ==

=== Request ===

GET /domains/greenenergy/namespinner?maxResults=10&addRelated=true&useHyphens=true&TLDList=com,net,org,us

=== Response ===
<nowiki>
{
"suggestions":[
{
"available":"true",
"name":"Green-Energy-Home",
"tld":"Com"
},
{
"available":"false",
"name":"Green-Energy-Home",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Home",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Home",
"tld":"Us"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Future",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Future",
"tld":"Net"
},
{
"available":"false",
"name":"Green-Energy-Future",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Future",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Wind-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Wind-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Wind-Energy",
"tld":"Org"
},
{
"available":"false",
"name":"Green-Wind-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Us"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Us"
}
]
}
</nowiki>

== NameSpinner Sample Code ==
HTML and JavaScript sample code is available for download [[Domains-domainName-namespinner:SAMPLE | here.]]

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Domains-domainName:GET|Check domain availability]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName:GET

2013-05-16T00:22:21Z

Philip.rittscher:

= GET /domains/''{domainName}'' =
Performs domain availability check.
__TOC__
== Request ==
<code>GET /domains/''{domainName}''</code>

==== 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 ===
<nowiki>
{
"available": "{available}",
"name": "{domainName}"
}
</nowiki>

==== 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 ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Domains-domainName-namespinner:GET|Name suggestion search]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName-namespinner:SAMPLE

2013-05-13T18:33:26Z

Philip.rittscher:

= SAMPLE /domains/''{domainName}''/namespinner =

This page contains JavaScript and HTML sources used to perform domain name availbility
searches for suggested domain names.

__TOC__

== JavaScript ==

<nowiki>/****
DISCLAIMER

The code examples, API, information, data, and other materials
(collectively "Materials") made available on this website are
provided on an "as is", "as available" basis, without any warranty as
to the completeness, accuracy, reliability, suitability,
availability, merchantability or fitness for a particular purpose.
Hostway expressly makes no warranty, representation, or guaranty as
to the content, sequence, timeliness, or completeness of the
Materials. Hostway further makes no warranty, representation, or
guaranty that the Materials will be uninterrupted or error free or
bug free. Hostway will not provide any support for the Materials, and
Hostway is not obligated correct any issues may exist in the
Materials whether or not Hostway has knowledge of such issues.
However, Hostway reserves the right to amend, modify, or delete all
or any portion of the Materials at any time at Hostway's sole
discretion, and such amendment, modification, or deletion may affect,
alter, or terminate the functionality of any previous versions of the
Materials (such as the code examples) without notice.

Hostway will have absolutely no liability in connection with or
arising from the Materials, your use of the Materials, or the
availability or unavailability of any of the Materials. Furthermore,
Hostway expressly disclaims all liability for, without limitation:
i. Any and all damage to your computer, hardware, data, information,
materials, and business arising from the Materials or your use,
modification, or distribution of the Materials;
ii. Any and all indirect or consequential loss or damage, loss of
data or loss of profits arising out of, or in connection with,
your use, modification, or distribution of the Materials;
iii. Any and all functions of any modifications that you make to the
Materials, including any loss, damage, or other liability
resulting from your modification of the Materials;
iv. Any and all losses or damages caused, in whole or in part, by
Hostway's actions, omissions, or negligence in procuring,
compiling, or delivering the Materials;
v. Any and all errors, omissions, or inaccuracies in the Materials
regardless of how caused, or delays or interruptions in delivery
of the Materials; or
vi. Any decision you or any third party may make, or action taken or
not taken, in reliance upon the Materials.
For the purposes of this disclaimer, "Hostway" includes, without
limitation, Hostway's divisions, affiliates, subsidiaries,
successors, parent companies, and their (including Hostway's)
executives, directors, officers, managers, employees, consultants,
contractors, agents, affiliates, third-party providers, merchants,
licensors or the like.
****/

var publicApiUrl = 'http://coreapi01.ote.chicago.hostway:8092';

/**
* suggestNames :
*
* Make an ajax request to get the availability of suggested domain names.
* Assembles querystring via queryStringMap
* Assemble url with
* 1. publicApiUrl
* 2. nameSuggest
* 3. querystring
*
* @constructor
* @this {suggestNames}
* @param {string} nameSuggest, the second level domain name text to spin.
* @param {Object.<string, string>} queryStringMap, a map of all the additional attributes to send as querystring.
* @param {function( { status: number, name: string, suggestions[{name:string, tld:string, available:boolean}] } )}
* resultHandler, function object holding the results of a spin call.
*
*/

function suggestNames(nameSuggest, queryStringMap, resultHandler) {

var qs = "";

//
// build query string with additional parameters to be sent with name spinner request
//
for(var key in queryStringMap){

if (queryStringMap.hasOwnProperty(key)) {

if(key=='maxResults' && queryStringMap[key] >= 0 && new Number(queryStringMap[key]) > 0 ){
qs = qs + "maxResults="+queryStringMap[key]+'&';
}

if(key=='addRelated' && queryStringMap[key]){
qs = qs + "AddRelated="+queryStringMap[key]+'&';
}

if(key=='useHyphens'){
qs = qs + "useHyphens="+queryStringMap[key]+'&';
}

if(key=='tldList' && (queryStringMap[key] != null && queryStringMap[key].length > 0)){
qs = qs + "TLDList="+queryStringMap[key]+'&';
}
}
}

// Remove invalid chars. Input should be a set of keywords like 'Smart Investor'
// or a second level domain name like 'smartinvestor.com'
//
nameSuggest = nameSuggest.replace("\\","");
nameSuggest = nameSuggest.replace("http://","");
nameSuggest = nameSuggest.replace("/","");
nameSuggest = nameSuggest.replace("www\.","");

var uri = '/domains/' + nameSuggest + '/namespinner';

//
// exec spinner request
//
$.ajax({
type: "GET",
url: publicApiUrl + uri +'?'+qs,
dataType: "json",
success: function(data, textStatus, jqXHR) {
console.log('SUCCESS ' + textStatus);
result = { status: jqXHR.status, name: nameSuggest, suggestions:data.suggestions };
resultHandler(result);
},
error: function(jqXHR, textStatus, errorThrown) {
console.log('Error status=' + jqXHR.status);
result = { status: jqXHR.status, name: nameSuggest};
resultHandler(result);
}
});
}
</nowiki>

== HTML ==

<nowiki>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml2/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />



<title>Domain Name Suggestions Availability Check</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.0/jquery.min.js"></script>
<script type="text/javascript" src="namespinner.js"></script>
<script type="text/javascript">

// show or hide advance attributes, default to false
var advacedAttr=false;

// show or hide help content, default to false
var help=false;

// Used only to show how long each name suggestion search takes.
var curTime = (new Date()).getTime();

/*
* UI help content hover action.
*/
(function($){
$(document).ready(function() {

//
// onclick show/remove advanced settings
//
$('#advancedSettings').click(function() {
if(!advacedAttr) {
$('[name=advancedSettings]').css("visibility","visible");
$('#content').css("height","290");
advacedAttr=true;
}else{
$('[name=advancedSettings]').css("visibility","hidden");
$('#content').css("height","50");
advacedAttr=false;

$('[name=help]').empty();
help=false;
}
});

//
// onclick show/remove help content
//
$('#help').click(function() {

if(!help){
$('[name=help]').append(
'<ul>'+
'<li>Add Related : Return domain names that are related to the SLD</li>'+
'<li>Use Hyphens : Return domain names that include hyphens</li>'+
'<li>Max Results : Maximum number of suggested names to return in <br/>'+
'addition to your input (between 0 and 99)'+
'</ul>'
);
help=true;
$('#content').css("height","490");
$('#content').css("width","400");
}else{
$('[name=help]').empty();
help=false;
$('#content').css("height","290");
$('#content').css("width","400");
}
});

//
// formatting of suggestion text area field
//
$('[name=nameSuggest]').click(function(){

if ($(this).val() == 'Enter search term') {
$(this).val('');
}
$(this).css('color','#333');
});

});
})(window.jQuery || window.$);

/****
*
* Callback function to display results returned in the suggestNames
* call. This function reads the name suggestion results returned by
* the Hostway Public API Server as a JSON structure. It keeps track
* of all the TLDs returned in the result and builds a list of the
* suggested names for each TLD and whether that name is available or
* not. It then builds an HTML table with the TLDs in the top row.
*
*/
function displayResult(result) {

/*****
------
An example of the results returned for the search term
'DerivativesMarket' and Max Results was set to 3. The three results
are 'DerivativesSell', 'DerivativesStore' and 'DerivativesShop'.
Note that useHyphens and addRelated do not have an impact on
the results in this case as the first 3 results do not make use of
hyphens or related words.

{
"suggestions": [
{"available": "true", "name": "DerivativesSell", "tld": "Com"},
{"available": "true", "name": "DerivativesSell", "tld": "Net"},
{"available": "true", "name": "DerivativesSell", "tld": "Org"},
{"available": "true", "name": "DerivativesSell", "tld": "Info"},
{"available": "true", "name": "DerivativesSell", "tld": "Biz"},
{"available": "true", "name": "DerivativesSell", "tld": "Pro"},
{"available": "true", "name": "DerivativesSell", "tld": "Mobi"},
{"available": "true", "name": "DerivativesSell", "tld": "Asia"},
{"available": "true", "name": "DerivativesSell", "tld": "Ca"},
{"available": "true", "name": "DerivativesSell", "tld": "Co"},
{"available": "true", "name": "DerivativesSell", "tld": "Us"},
{"available": "true", "name": "DerivativesStore", "tld": "Com"},
{"available": "true", "name": "DerivativesStore", "tld": "Net"},
{"available": "true", "name": "DerivativesStore", "tld": "Org"},
{"available": "true", "name": "DerivativesStore", "tld": "Info"},
{"available": "true", "name": "DerivativesStore", "tld": "Biz"},
{"available": "true", "name": "DerivativesStore", "tld": "Pro"},
{"available": "true", "name": "DerivativesStore", "tld": "Mobi"},
{"available": "true", "name": "DerivativesStore", "tld": "Asia"},
{"available": "true", "name": "DerivativesStore", "tld": "Ca"},
{"available": "true", "name": "DerivativesStore", "tld": "Co"},
{"available": "true", "name": "DerivativesStore", "tld": "Us"},
{"available": "false", "name": "DerivativesShop", "tld": "Com"},
{"available": "false", "name": "DerivativesShop", "tld": "Net"},
{"available": "true", "name": "DerivativesShop", "tld": "Org"},
{"available": "true", "name": "DerivativesShop", "tld": "Info"},
{"available": "true", "name": "DerivativesShop", "tld": "Biz"},
{"available": "false", "name": "DerivativesShop", "tld": "Pro"},
{"available": "true", "name": "DerivativesShop", "tld": "Mobi"},
{"available": "true", "name": "DerivativesShop", "tld": "Asia"},
{"available": "true", "name": "DerivativesShop", "tld": "Ca"},
{"available": "true", "name": "DerivativesShop", "tld": "Co"},
{"available": "true", "name": "DerivativesShop", "tld": "Us"}
]
}
------
*****/

$("#resultMsg").css('text-decoration', 'none');

if (result.status == 200) {

var headerArr = [];
var suggestions = {};

var content = "";

$.each(result.suggestions, function(key, suggestion) {

// Add each TLD to a header array for display.
if ( $.inArray( suggestion.tld, headerArr ) == -1 ) {
headerArr.push(suggestion.tld);
}

// And build a dictionary of results that looks like this:
// {
// "suggested1": {"com": {"available" :"true"}, "net": {"available" :"false"}},
// "suggested2": {"com": {"available" :"false"}, "net": {"available" :"false"}}
// }
if (!(suggestion.name in suggestions)) {
suggestions[suggestion.name] = {};
}
suggestions[suggestion.name][suggestion.tld] = {};
suggestions[suggestion.name][suggestion.tld].available = suggestion.available;

});

// Show the results, including TLDs header in a table
content += "<table><tr><td><strong>Name</strong></td>";
for(name in headerArr) {
content+= "<td cellspacing=\"25px\"><strong>."+headerArr[name].toLowerCase()+"</strong></td>";
}
content += "</tr>";

for(var name in suggestions) {

var str = "<tr><td>"+name+"</td>";
for (var tld in suggestions[name]) {

if (suggestions[name][tld].available == 'true') {
// include a checkbox for a domain because the domain is available and could
// be selected for registration
str += "<td align=\"center\"><input type=\"checkbox\" name=\"domain\" value=\""+name+"."+tld+"\"/></td>";
}
else {
// suggested domain name is not available for this TLD.
str += "<td align=\"center\">X</td>";
}
}
str += "</tr>";
content += str;
}
content += "</table>";
alert
var deltaTime = (new Date()).getTime() - curTime ;

$(".namespinnerResult").html(content);
$("#resultMsg").css('text-decoration', 'none');
$("#resultMsg").text(" (results in "+deltaTime +" ms)");

} else {
$("#resultMsg").text("Error (" + result.status + ")");
}
}

/*
* Submit the query.
*/
function nameSearch() {

//
// nameSuggest - the second level domain string used to search for additional suggestions
//
var nameSuggest = $('[name=nameSuggest]').val();

// used to show the time taken to perform the lookup.
curTime = (new Date()).getTime();

// gather form submittion fields
var tldList="";
var i = 0;
$(':checkbox').each(function() {
if(this.name == 'tld' && this.checked){
// append the TLD to the query string
tldList = tldList + $(this).attr('value') +',';
}
});

if(tldList.charAt( tldList.length-1 ) == ",") {
tldList = tldList.slice(0, -1);
}

var addRelated = $('[name=AddRelated]').attr('checked')?true:false;

var useHyphens = $('[name=UseHyphens]').attr('checked')?true:false;

var maxResults = $('[name=MaxResults]').val();

$("#resultMsg").css('text-decoration', 'blink');

$(".namespinnerResult").empty();

$("#resultMsg").text("Checking ...");

// Form field validation
var errorMessage;
if (isNaN(maxResults / 1) != false) {
errorMessage = "maxResults needs to be between 0 and 99";
} else if (nameSuggest.indexOf("\\") !=-1) {
errorMessage = "Please remove \\ from the name suggestion string";
} else if (nameSuggest.indexOf("http://") == 0) {
errorMessage = "Please remove http:// from the name suggestion string";
} else if (nameSuggest.indexOf("/") !=-1) {
errorMessage = "Please remove / from the name suggestion string";
} else if (nameSuggest.indexOf("www.") == 0) {
errorMessage = "Please remove www. from the name suggestion string";
}

// Upon error, display message and stop execution
if(errorMessage != null){
$("#resultMsg").text(errorMessage);
$("#resultMsg").css('color','red');
return;
}

// querystring map information in order to submit additional attribute (not required).
// empty querystring will results in default behaviour
var queryString = {
'tldList': tldList,
'addRelated': addRelated,
'useHyphens': useHyphens,
'maxResults': maxResults
};

// call namespinner
//
suggestNames(nameSuggest, queryString, displayResult);

}

</script>
</head>

<style type="text/css">
.div1{ display:inline; color:green;}
.div2{ display:inline;visibility:hidden;}
</style>

<body>

<div id="info" style="width: 400px;">

<b>Domain name suggestion tool </b> -
This page provides a basic example of the domain name suggestion tool
which generates search results for domains that are similar to the one
provided as input. Search results can be adjusted by allowing the use
of hyphens separating words and by allowing the use of related words.
The number of results can set from 1 to 99 with the default being 20.
The set of To Level Domains (TLDs) can also be controlled.

</div>
<br/>
<div id="content" style="background-color: #fafafa; border: solid 1px #333333; padding: 20px; padding-top: 0px; width: 400px; height: 50px;">

<form method="post" id="domainSearchForm" onsubmit="nameSearch(); return false;">
<div id="formContent">
<br>
<input type="text" name="nameSuggest" size="30" maxlength="60" value="Enter search term"/><input type="submit" name="SearchButton" value="Get suggestions" />
<br/>
<a id="advancedSettings" href="#">Advanced setting</a>
<br>

<div name="advancedSettings" class="div2">
<table border="0" width="400">
<tr>
<td><input type="checkbox" name="UseHyphens" value="1"/></td><td>Use Hyphens</td>
</tr>
<tr>
<td><input type="checkbox" name="AddRelated" value="1"/></td><td>Add Related</td>
</tr>
<tr>
<td><input type="text" name="MaxResults" size="2" maxlength="2"/></td><td>Max Results</td>
</tr>
<tr>
<td valign="top">Tld list<div class="div1" name="tldListHelp"></div></td>
<td>
<table>
<tr>
<td><input type="checkbox" name="tld" value="com" id="com"/><label for="com">com</label></td>
<td><input type="checkbox" name="tld" value="net" id="net"/> <label for="net">net</label> </td>
<td><input type="checkbox" name="tld" value="org" id="org"/> <label for="org">org</label> </td>
<td><input type="checkbox" name="tld" value="info" id="info"/> <label for="info">info</label> </td>
</tr>
<tr>
</tr>
<tr>
<td><input type="checkbox" name="tld" value="co" id="co"/> <label for="co">co</label> </td>
<td><input type="checkbox" name="tld" value="biz" id="biz"/> <label for="biz">biz</label> </td>
<td><input type="checkbox" name="tld" value="pro" id="pro"/> <label for="pro">pro</label> </td>
<td><input type="checkbox" name="tld" value="mobi" id="mobi"/> <label for="mobi">mobi</label> </td>
</tr>

<tr>
<td><input type="checkbox" name="tld" value="us" id="us"/> <label for="us">us</label> </td>
<td><input type="checkbox" name="tld" value="ca" id="ca"/> <label for="ca">ca</label> </td>
<td><input type="checkbox" name="tld" value="asia" id="asia"/> <label for="asia">asia</label> </td>
</tr>

<tr>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" align="left">
<a id="help" href="#">Help</a>
<br/>
<div name="help"></div>
</td>
</tr>

</table>
</div>
</div>
</form>

</div>
<div style="text-align:left" id="resultMsg"></div>
<div class="namespinnerResult"></div>
</body>
</html>
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName-hold:DELETE

2013-03-25T18:08:24Z

Philip.rittscher: /* DELETE /domains/{domainName}/hold */

= DELETE /domains/''{domainName}''/hold =
Delete a domain name hold status. This corresponds to a status of 'clientHold' at the registry. Deleting a hold status removes the clientHold status from a domain. This means the DNS records for the domain will be re-published in the registry name servers and the domain should start resolving. Removal of a hold status may fail if there is another status that prevents the operation such as 'pendingTransfer', 'clientUpdateProhibited' or 'serverUpdateProhibited'.

__TOC__
== Request ==
<code>DELETE/domains/''{domainName}''/hold</code>

==== Parameters ====
; domainName - string
: The valid domain name to unhold including only the labels that are appropriate for a valid domain name. IE: '''example.com''' is a valid domain name , whereas '''http://www.example.com''' or '''www.example.com''' are not. If the domain name is invalid, or is otherwise not registered, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.

=== URI Parameters ===
None.

=== Request Headers ===
None.

=== Request Body ===
;None

== Response ==

=== Status Code ===
;204 OK (No Content)
: Domain lock hold successfully removed.

;400 Bad Request
: The domain name is not valid.

;403 Forbidden
: Domain is not registered in this account and cannot be accessed.

;404 Not Found
: No domain records found for the given domain name.

=== Response Body ===
;None

== Example remove a hold from a domain. ==
'''Request'''
<nowiki>
DELETE /domains/example.com/hold
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName-hold:PUT

2013-03-25T18:04:13Z

Philip.rittscher:

= PUT /domains/''{domainName}''/hold =
Put a domain name on hold status. This corresponds to a status of 'clientHold' at the registry. A domain name with this status is removed from the registry zone files and will cease resolving but may be transferred to another registrar, may be renewed and it may be modified; such as changes to the name servers or contact info.

__TOC__
== Request ==
<code>PUT /domains/''{domainName}''/hold</code>

==== Parameters ====
; domainName - string
: The valid domain name to put on hold including only the labels that are appropriate for a valid domain name. IE: '''example.com''' is a valid domain name , whereas '''http://www.example.com''' or '''www.example.com''' are not. If the domain name is invalid, or is otherwise not registered, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.

=== URI Parameters ===
None.

=== Request Headers ===
None.

=== Request Body ===
;true
:Set the body to 'true' in order to add the hold.

;false
:Set the body to 'false' in order to have the hold removed.

== Response ==

=== Status Code ===
;204 OK (No Content)
: Domain hold status applied successfully.

;400 Bad Request
: The domain name is not valid.

;403 Forbidden
: Domain is not registered in this account and cannot be accessed.

;404 Not Found
: No domain records found for the given domain name.

=== Response Body ===
;None

== Example remove hold on a domain. ==
'''Request'''
<nowiki>
PUT /domains/example.com/hold

false
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName-lock:DELETE

2013-03-25T17:58:53Z

Philip.rittscher:

= DELETE /domains/''{domainName}''/lock =
Delete a domain name lock status. This corresponds to a status of 'clientTransferProhibited' at the registry. Deleting a lock status removes the clientTransferProhibited status from a domain. This means the domain name may be transferred to another registrar, providing no other status is assigned to the domain that prevents a transfer such as serverTransferProhibited, pendingTransfer, redemptionPeriod, or pendingDelete.

__TOC__
== Request ==
<code>DELETE/domains/''{domainName}''/lock</code>

==== Parameters ====
; domainName - string
: The valid domain name to unlock including only the labels that are appropriate for a valid domain name. IE: '''example.com''' is a valid domain name , whereas '''http://www.example.com''' or '''www.example.com''' are not. If the domain name is invalid, or is otherwise not registered, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.

=== URI Parameters ===
None.

=== Request Headers ===
None.

=== Request Body ===
;None

== Response ==

=== Status Code ===
;204 OK (No Content)
: Domain lock status applied successfully.

;400 Bad Request
: The domain name is not valid.

;403 Forbidden
: Domain is not registered in this account and cannot be accessed.

;404 Not Found
: No domain records found for the given domain name.

=== Response Body ===
;None

== Example unlock domain. ==
'''Request'''
<nowiki>
DELETE /domains/example.com/lock
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

Domains-domainName-lock:PUT

2013-03-25T17:53:54Z

Philip.rittscher:

= PUT /domains/''{domainName}''/lock =
Put a domain name on lock status. This corresponds to a status of 'clientTransferProhibited' at the registry. A domain name with this status cannot be transferred to another registrar but may be renewed and it may be modified; such as changes to the name servers or contact info.

__TOC__
== Request ==
<code>PUT /domains/''{domainName}''/lock</code>

==== Parameters ====
; domainName - string
: The valid domain name to retrieve including only the labels that are appropriate for a valid domain name. IE: '''example.com''' is a valid domain name , 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. The domain name must be an open or suspended product under the authenticated franchise.

=== URI Parameters ===
None.

=== Request Headers ===
None.

=== Request Body ===
;true
:Set the body to 'true' in order to add the lock.

;false
:Set the body to false in order to have the lock removed.

== Response ==

=== Status Code ===
;204 OK (No Content)
: Domain lock status applied successfully.

;400 Bad Request
: The domain name is not valid.

;403 Forbidden
: Domain is not registered in this account and cannot be accessed.

;404 Not Found
: No domain records found for the given domain name.

=== Response Body ===
;None

== Example lock domain. ==
'''Request'''
<nowiki>
PUT /domains/example.com/lock

true
</nowiki>

'''Response'''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]