Latest revision as of 11:57, 3 April 2015

[edit] GET /accounts/{accountNumber}/web/{domainName}

Returns detail information for a {domainName} website.

[edit] Request

GET /accounts/{accountNumber}/web/{domainName}

[edit] 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

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

[edit] Response

[edit] Response Body

{
    "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}"
        }
    ]
}
 

[edit] 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

[edit] 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

[edit] Examples

[edit] Successful retrieving websites

Request

GET /accounts/acct411359/web/ng-test-website3-20150306-1200.com
 

Response

{
          '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'
        };