Skip to main content

List FTP Accounts

Returns a list of FTP accounts associated with your ftpGrid account.

This endpoint can be used to:

  • inspect configured accounts
  • audit integrations
  • retrieve account IDs
  • synchronize external systems
  • manage tenant-based environments

Required Scope​

ftpaccount.list

Endpoint​

GET /ftpaccounts

Example Request​

http GET https://api.ftpgrid.com/ftpaccounts \
Authorization:"Bearer YOUR_TOKEN"

Example Response​

[
    {
        "id": 1234,
        "username": "camera01",
        "accessRights": "RW",
        "chroot": "/uploads",
        "description": "Warehouse camera",
        "enabled": true
    },
    {
        "id": 1235,
        "username": "scanner01",
        "accessRights": "RO",
        "chroot": "/incoming",
        "description": "Office scanner",
        "enabled": false
    }
]

Notes

  • Passwords are never returned by the API
  • SSH public keys may be omitted depending on configuration
  • Disabled accounts are included in the response
  • Account IDs are unique within your ftpGrid association