Accounts-accountNumber-web-domainName-ssh-SshUsername:GET

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

Returns details of an ssh account.

Request

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

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 ssh account

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Response

Response Body

{
   "username": "{username}",
   "status": "{status}",
   "domain": "{domain}",
   "type": "{sshAccountType}",
   "server": "{server}"
}
 

Response parameters =

username - string

The username of the ssh account

status - string

Status of the ssh account (needs explanation)

domain - string

The domain name of the web site

sshAccountType - string

The type of the ssh account, one of "www.account.master", "www.account.shell". There is always one master account which can't be deleted. There are also regular ssh accounts.

server - string

The ssh server name for the ssh 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 ssh account doesn't exist

Examples

Getting details for an ssh accounts

Request

GET /accounts/acct411359/web/ng-test-website1-20150305-0734.us/ssh/testssh053247
 

Response

{
    "username": "testssh053247",
    "status": "1",
    "domain": "ng-test-website1-20150305-0734.us",
    "type": "www.account.shell"
}

blog comments powered by Disqus