Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
FTP Accounts

Create new ftp account

Endpoint that can be used to create a new ftp account for given site.

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

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

usernamestring required

FTP account username (without domain)

passwordstring required

Password for the FTP account

homedirstring required

Document root for the FTP account (relative the user's home directory)

quotainteger required

FTP disk space quota in MB (0 = unlimited)

domainstring required

Example request

{
  "username": "ftpuser",
  "password": "R3@llyStr0ng!P@55w0rd_123456",
  "homedir": "public_html",
  "quota": 500
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "dir": "/home/abcd1234/public_html",
    "diskquota": 500,
    "user": "ftpuser@site.rocket.net"
  }
}