Web API
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 100) |
Mike.robski (Talk | contribs) m (1 revision: Release 109) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
[{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book] | [{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book] | ||
| − | == | + | == Websites == |
| + | <blockquote> | ||
| + | === Websites === | ||
| + | * [[accounts-accountNumber-web-:GET|GET /accounts/{accountNumber}/web]] - Returns a list of websites | ||
| + | * [[accounts-accountNumber-web-domainName:GET|GET /accounts/{accountNumber}/web/{domainName}]] - Returns a detailed information about a website | ||
| + | </blockquote> | ||
| + | |||
| + | == Aliases == | ||
<blockquote> | <blockquote> | ||
=== Aliases === | === Aliases === | ||
| − | * [[accounts-accountNumber-web-domainName-aliases-AliasDomainName:GET|GET /accounts/{accountNumber}/web/{domainName}/aliases/{ | + | * [[accounts-accountNumber-web-domainName-aliases:GET|GET /accounts/{accountNumber}/web/{domainName}/aliases]] - Returns a list of the domain name aliases |
| − | * [[accounts-accountNumber-web-domainName-aliases-AliasDomainName:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/aliases/{ | + | * [[accounts-accountNumber-web-domainName-aliases-AliasDomainName:GET|GET /accounts/{accountNumber}/web/{domainName}/aliases/{alias}]] - Returns details of the domain name alias |
| + | * [[accounts-accountNumber-web-domainName-aliases:POST|POST /accounts/{accountNumber}/web/{domainName}/aliases]] - Adds domain name alias | ||
| + | * [[accounts-accountNumber-web-domainName-aliases-AliasDomainName:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/aliases/{alias}]] - Deletes domain name alias | ||
| + | </blockquote> | ||
| + | |||
| + | == Sub Domains == | ||
| + | <blockquote> | ||
| + | === Sub Domains === | ||
| + | * [[accounts-accountNumber-web-domainName-subdomains:GET|GET /accounts/{accountNumber}/web/{domainName}/subdomains]] - Returns a list of sub domains | ||
| + | * [[accounts-accountNumber-web-domainName-subdomains-subDomain:GET|GET /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain}]] - Returns details of the sub domain | ||
| + | * [[accounts-accountNumber-web-domainName-subdomains:POST|POST /accounts/{accountNumber}/web/{domainName}/subdomains]] - Adds sub domain name | ||
| + | * [[accounts-accountNumber-web-domainName-subdomains-subDomain:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain}]] - Deletes sub domain | ||
| + | </blockquote> | ||
| + | |||
| + | == FTP Accounts == | ||
| + | <blockquote> | ||
| + | === FTP Accounts === | ||
| + | * [[accounts-accountNumber-web-domainName-ftp:GET|GET /accounts/{accountNumber}/web/{domainName}/ftp]] - Returns list of ftp accounts for the web site | ||
| + | * [[accounts-accountNumber-web-domainName-ftp-FtpUsername:GET|GET /accounts/{accountNumber}/web/{domainName}/ftp/{FtpUsername}]] - Returns details of the ftp account | ||
| + | * [[accounts-accountNumber-web-domainName-ftp:POST|POST /accounts/{accountNumber}/web/{domainName}/ftp]] - Add ftp account | ||
| + | * [[accounts-accountNumber-web-domainName-ftp-FtpUsername:PUT|PUT /accounts/{accountNumber}/web/{domainName}/ftp/{FtpUsername}]] - Update ftp account (change password) | ||
| + | * [[accounts-accountNumber-web-domainName-ftp-FtpUsername:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/ftp/{FtpUsername}]] - Delete ftp account | ||
| + | |||
| + | </blockquote> | ||
| + | |||
| + | == SSH Accounts == | ||
| + | <blockquote> | ||
| + | === SSH Accounts === | ||
| + | * [[accounts-accountNumber-web-domainName-ssh:GET|GET /accounts/{accountNumber}/web/{domainName}/ssh]] - Returns list of ssh accounts for the web site | ||
| + | * [[accounts-accountNumber-web-domainName-ssh-SshUsername:GET|GET /accounts/{accountNumber}/web/{domainName}/ssh/{SshUsername}]] - Returns details of the ssh account | ||
| + | * [[accounts-accountNumber-web-domainName-ssh:POST|POST /accounts/{accountNumber}/web/{domainName}/ssh]] - Add ssh account | ||
| + | * [[accounts-accountNumber-web-domainName-ssh-SshUsername:PUT|PUT /accounts/{accountNumber}/web/{domainName}/ssh/{SshUsername}]] - Update ssh account (change password) | ||
| + | * [[accounts-accountNumber-web-domainName-ssh-SshUsername:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/ssh/{SshUsername}]] - Delete ssh account | ||
| + | |||
| + | </blockquote> | ||
| + | |||
| + | == PHP == | ||
| + | <blockquote> | ||
| + | === PHP === | ||
| + | * [[accounts-accountNumber-web-domainName-php:GET|GET /accounts/{accountNumber}/web/{domainName}/php]] - Checks if PHP feature is enabled for a domain | ||
| + | * [[accounts-accountNumber-web-domainName-php:PUT|PUT /accounts/{accountNumber}/web/{domainName}/php]] - Sets PHP feature to a domain | ||
| + | * [[accounts-accountNumber-web-domainName-php:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/php]] - Deletes PHP feature from a domain | ||
| + | </blockquote> | ||
| + | |||
| + | == SSL == | ||
| + | <blockquote> | ||
| + | === SSL === | ||
| + | * [[accounts-accountNumber-web-domainName-ssl:GET|GET /accounts/{accountNumber}/web/{domainName}/ssl]] - Get Ssl detail for existing account | ||
| + | * [[accounts-accountNumber-web-domainName-ssl-canorder:GET|GET /accounts/{accountNumber}/web/ssl]] - Get Ssl certificates an existing account can order | ||
| + | * [[accounts-accountNumber-web-domainName-ssl:POST|POST /accounts/{accountNumber}/web/{domainName}/ssl]] - Add SSL certificate | ||
| + | * [[accounts-accountNumber-web-domainName-ssl-renew:POST|POST /accounts/{accountNumber}/web/{domainName}/ssl]] - Renew SSL certificate | ||
| + | </blockquote> | ||
| + | |||
| + | == SiteBuilder == | ||
| + | <blockquote> | ||
| + | === SiteBuilder === | ||
| + | * [[accounts-accountNumber-web-domainName-sitebuilder:GET|GET /accounts/{accountNumber}/web/{domainName}/siteBuilder]] - Checks if SiteBuilder product is enabled for a domain | ||
| + | * [[accounts-accountNumber-web-domainName-sitebuilder:PUT|PUT /accounts/{accountNumber}/web/{domainName}/siteBuilder]] - Adds SiteBuilder product to a domain | ||
| + | * [[accounts-accountNumber-web-domainName-sitebuilder:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/siteBuilder]] - Deletes SiteBuilder product from a domain | ||
| + | </blockquote> | ||
| + | |||
| + | == WebSiteBuilder == | ||
| + | <blockquote> | ||
| + | === WebSiteBuilder === | ||
| + | * [[accounts-accountNumber-web-domainName-websitebuilder:GET|GET /accounts/{accountNumber}/web/{domainName}/websiteBuilder]] - Checks if WebSiteBuilder product is enabled for a domain | ||
| + | * [[accounts-accountNumber-web-domainName-websitebuilder:PUT|PUT /accounts/{accountNumber}/web/{domainName}/websiteBuilder]] - Adds WebSiteBuilder product to a domain | ||
| + | * [[accounts-accountNumber-web-domainName-websitebuilder:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/websiteBuilder]] - Deletes WebSiteBuilder product from a domain | ||
| + | </blockquote> | ||
| + | |||
| + | == Error 404 == | ||
| + | <blockquote> | ||
| + | === Error 404 === | ||
| + | * [[accounts-accountNumber-web-domainName-error404:GET|GET /accounts/{accountNumber}/web/{domainName}/error404]] - Gets error page | ||
| + | * [[accounts-accountNumber-web-domainName-error404:PUT|PUT /accounts/{accountNumber}/web/{domainName}/error404]] - Sets error page to a domain | ||
| + | * [[accounts-accountNumber-web-domainName-error404:DELETE|DELETE /accounts/{accountNumber}/web/{domainName}/error404]] - Deletes error page from a domain | ||
</blockquote> | </blockquote> | ||
Latest revision as of 12:16, 24 July 2015
The Web API provides access to information about the web hosting products.
Contents |
download this selection of articles as a PDF book
Websites
Websites
- GET /accounts/{accountNumber}/web - Returns a list of websites
- GET /accounts/{accountNumber}/web/{domainName} - Returns a detailed information about a website
Aliases
Aliases
- GET /accounts/{accountNumber}/web/{domainName}/aliases - Returns a list of the domain name aliases
- GET /accounts/{accountNumber}/web/{domainName}/aliases/{alias} - Returns details of the domain name alias
- POST /accounts/{accountNumber}/web/{domainName}/aliases - Adds domain name alias
- DELETE /accounts/{accountNumber}/web/{domainName}/aliases/{alias} - Deletes domain name alias
Sub Domains
Sub Domains
- GET /accounts/{accountNumber}/web/{domainName}/subdomains - Returns a list of sub domains
- GET /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain} - Returns details of the sub domain
- POST /accounts/{accountNumber}/web/{domainName}/subdomains - Adds sub domain name
- DELETE /accounts/{accountNumber}/web/{domainName}/subdomains/{subDomain} - Deletes sub domain
FTP Accounts
FTP Accounts
- GET /accounts/{accountNumber}/web/{domainName}/ftp - Returns list of ftp accounts for the web site
- GET /accounts/{accountNumber}/web/{domainName}/ftp/{FtpUsername} - Returns details of the ftp account
- POST /accounts/{accountNumber}/web/{domainName}/ftp - Add ftp account
- PUT /accounts/{accountNumber}/web/{domainName}/ftp/{FtpUsername} - Update ftp account (change password)
- DELETE /accounts/{accountNumber}/web/{domainName}/ftp/{FtpUsername} - Delete ftp account
SSH Accounts
SSH Accounts
- GET /accounts/{accountNumber}/web/{domainName}/ssh - Returns list of ssh accounts for the web site
- GET /accounts/{accountNumber}/web/{domainName}/ssh/{SshUsername} - Returns details of the ssh account
- POST /accounts/{accountNumber}/web/{domainName}/ssh - Add ssh account
- PUT /accounts/{accountNumber}/web/{domainName}/ssh/{SshUsername} - Update ssh account (change password)
- DELETE /accounts/{accountNumber}/web/{domainName}/ssh/{SshUsername} - Delete ssh account
PHP
PHP
- GET /accounts/{accountNumber}/web/{domainName}/php - Checks if PHP feature is enabled for a domain
- PUT /accounts/{accountNumber}/web/{domainName}/php - Sets PHP feature to a domain
- DELETE /accounts/{accountNumber}/web/{domainName}/php - Deletes PHP feature from a domain
SSL
SSL
- GET /accounts/{accountNumber}/web/{domainName}/ssl - Get Ssl detail for existing account
- GET /accounts/{accountNumber}/web/ssl - Get Ssl certificates an existing account can order
- POST /accounts/{accountNumber}/web/{domainName}/ssl - Add SSL certificate
- POST /accounts/{accountNumber}/web/{domainName}/ssl - Renew SSL certificate
SiteBuilder
SiteBuilder
- GET /accounts/{accountNumber}/web/{domainName}/siteBuilder - Checks if SiteBuilder product is enabled for a domain
- PUT /accounts/{accountNumber}/web/{domainName}/siteBuilder - Adds SiteBuilder product to a domain
- DELETE /accounts/{accountNumber}/web/{domainName}/siteBuilder - Deletes SiteBuilder product from a domain
WebSiteBuilder
WebSiteBuilder
- GET /accounts/{accountNumber}/web/{domainName}/websiteBuilder - Checks if WebSiteBuilder product is enabled for a domain
- PUT /accounts/{accountNumber}/web/{domainName}/websiteBuilder - Adds WebSiteBuilder product to a domain
- DELETE /accounts/{accountNumber}/web/{domainName}/websiteBuilder - Deletes WebSiteBuilder product from a domain
Error 404
Error 404
- GET /accounts/{accountNumber}/web/{domainName}/error404 - Gets error page
- PUT /accounts/{accountNumber}/web/{domainName}/error404 - Sets error page to a domain
- DELETE /accounts/{accountNumber}/web/{domainName}/error404 - Deletes error page from a domain
See also
