Accounts-accountNumber-web-domainName-ssh:GET
From Hostway API Documentation
GET /accounts/{accountNumber}/web/{domainName}/ssh
Returns a list of ssh accounts for the website.
Contents |
Request
GET /accounts/{accountNumber}/web/{domainName}/ssh
URI Parameters
- accountNumber - string
- The user account of the web site owner
- domainName - string
- The domain name of the website
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Response
Response Body
{
"users":
[
{
"username": "{username}",
"type": "{sshAccountType}"
},
...
]
}
Response parameters =
- username - string
- The username of the ssh account
- 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.
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 ssh accounts for a website
Request
GET /accounts/acct411359/web/ng-test-website1-20150305-0734.us/ssh
Response
{
"users": [
{
"username": "ng-test-website1-35",
"type": "www.account.master"
},
{
"username": "testssh1",
"type": "www.account.shell"
},
{
"username": "testssh053247",
"type": "www.account.shell"
}
]
}