v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
FTP Accounts

Update ftp account

Updates ftp account for given username

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

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

usernamestring required

FTP account username (with domain)

Example:ftpuser@site.rocket.net

Request body

new_passwordstring

Password for the FTP account

quotainteger

FTP disk space quota in MB (0 = unlimited)

homedirstring

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

Example request

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

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "quota": 500,
    "homedir": "public_html"
  }
}