POST · FTP & SSH access
List, create, delete or re-password FTP accounts
List, create, delete or re-password FTP accounts
/api/v1/hosting/ftp
Description
action=list returns each account {account, home, isSystem} and needs only read access. create needs account and password (optional path for a custom home); delete needs account; password needs account and password. Those three require write:hosting. The main system account cannot be deleted or re-passworded here.
Body
Send as application/json.
| Name | Type | Description |
|---|---|---|
input
required
|
string |
A domain, email address, website URL, or Inleed service id — for example example.se, [email protected] or 42976. Resolved to the owning account automatically, and the resolved target is echoed back in the response.
|
action
required
|
enum |
list all accounts, create a new one, delete one, or password to change one's password. All but list require write:hosting. One of list, create, delete, password.
|
account
|
string |
The FTP account's local name (e.g. deploy) — not [email protected].
|
password
|
string |
The new FTP password (min 8 chars). Required for create and password.
|
path
|
string |
Optional absolute home path for a create (e.g. /domains/example.com/public_html); defaults to the domain directory.
|
Responses
The specification does not describe this response body; the note in the rail says what to expect.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.