Accounts-accountNumber-web-domainName-ftps-FtpUsername:GET

From Hostway API Documentation
Jump to: navigation, search

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

Returns details of an ftp account.

Contents


Request

GET /accounts/{accountNumber}/web/{domainName}/ftp/{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 ftp 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": "{ftpAccountType}",
   "server": "{server}"
}
 

Response parameters =

username - string
The username of the ftp account
status - string
Status of the ftp account (needs explanation)
domain - string
The domain name of the web site
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).
server - string
The ftp server name for the ftp 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 ftp account doesn't exist

Examples

Getting details for an ftp accounts

Request

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

Response

{
   "username": "testftp1",
   "status": "1",
   "domain": "ng-test-website1-20150305-0734.us",
   "type": "www.account.ftp",
   "server": "pegasus-vip.bhp.staging.chicago.hostway"
}



blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox