Retrieve FTP Account
Retrieves details about a single FTP account.
This endpoint can be used to inspect:
- authentication configuration
- access rights
- chroot isolation
- enabled/disabled status
- SSH key configuration
Required Scope
ftpaccount.get
Endpoint
GET /ftpaccounts/id/:id
Example Request
http GET https://api.ftpgrid.com/ftpaccounts/id/1234 \
Authorization:"Bearer YOUR_TOKEN"
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | integer | FTP account ID |
Example Response
{
"id": 1234,
"associationKey": "f7bd3870-477c-4ab0-a990-ad2b4d2e5452",
"username": "camera01",
"accessRights": "RW",
"chroot": "/uploads",
"description": "Warehouse camera",
"enabled": true,
"rsaKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI..."
}
Notes
- Passwords are never returned by the API
- SSH public keys may be returned depending on permissions and configuration
- FTP accounts are isolated to their configured chroot directory
- Disabled accounts cannot authenticate using FTP, FTPS, SFTP, or SCP