Accounts-accountNumber-web-domainName-ftp:GET

From Hostway API Documentation
Jump to: navigation, search

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

Returns a list of ftp accounts for the website.

Contents


Request

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

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": "{ftpAccountType}"
       },
       ...
   ]
}
 

Response parameters =

username - string
The username of the ftp account
ftpAccountType - string
The type of the ftp account, one of "www.account.master", "www.account.ftp", "www.account.subftp". There is always one master account which can't be deleted. There are also regular ftp accounts and sub dir ftp accounts associated with a sub folder (currently folder name is the same as the username).

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 ftp accounts for a website

Request

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

Response

{
   "users":
   [
       {
           "username": "ng-test-website1-35",
           "type": "www.account.master"
       },
       {
           "username": "testftp1",
           "type": "www.account.ftp"
       },
       {
           "username": "testsubftp1",
           "type": "www.account.subftp"
       }
   ]
}



blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox