Web API

Latest revision as of 12:16, 24 July 2015

The Web API provides access to information about the web hosting products.

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

• Common Features