Mike.robski: 1 revision: Release 105

2015-04-03T17:57:24Z

1 revision: Release 105

Philip.rittscher: changed from FTPS to FTP

2015-03-17T18:38:17Z

changed from FTPS to FTP

New page

= GET /accounts/{accountNumber}/web/{domainName}/ftp =
Returns a list of ftp accounts for the website.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/ftp</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account of the web site owner
; domainName - ''string''
: The domain name of the website

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"users":
[
{
"username": "{username}",
"type": "{ftpAccountType}"
},
...
]
}
</nowiki>

=== 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'''
<nowiki>
GET /accounts/acct411359/web/ng-test-website1-20150305-0734.us/ftp
</nowiki>

'''Response'''
<nowiki>
{
"users":
[
{
"username": "ng-test-website1-35",
"type": "www.account.master"
},
{
"username": "testftp1",
"type": "www.account.ftp"
},
{
"username": "testsubftp1",
"type": "www.account.subftp"
}
]
}
</nowiki>

{{disqus}}
[[Category:Hostway API]]
[[Category:Web API]]

Accounts-accountNumber-web-domainName-ftps:GET - Revision history

Mike.robski: 1 revision: Release 105

Philip.rittscher: changed from FTPS to FTP