Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
FTP Accounts

List Ftp Accounts

Get list of ftp accounts associated with given site, can be filtered by ftp username.

get/v1/sites/{id}/ftp/accounts

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

usernamestring

Search for usernames matching this string

Example:ammar
pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page (default = 10)

sort'dir' | 'diskquota' | 'diskused' | 'reldir' | 'user'

sort results by this property (omit for sort by user)

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "dir": "/home/abcd1234/public_html",
      "diskquota": 500,
      "diskused": "308.98",
      "reldir": "public_html",
      "user": "ftpuser@site.rocket.net"
    }
  ]
}