Null FTP Server HTTP API Documentation
Main resources
The resources below are directly exposed via the HTTP API. You can GET, PUT, and DELETE them using respective resource URLs. Put * as the resource name to GET all resources of a given type.
| Name | URL | Description |
|---|
ServerSettings | / | A single resource containing general server settings. |
AccessPoint | /accesspoints/<Name> | Access points provide means to access server's resources. Each access point provides access using a single protocol on a single port. |
SecurityCertificate | /certificates/ | |
SecuritySettings | /security/ | A single resource that specifies enabled account types to use by Null FTP Server for user authentication |
Acl | /security/acl/<Name> | An Access Control List describing access to a single file or directory. |
UserGroup | /usergroups/<Name> | A user group can have total and per-user disk usage quota, also it can have a customized SITE command set. |
User | /users/<Name> | User resources represent accounts registered on the NullFTP server; accounts are used to access the server files through available access points. |
VirtualDirectory | /virtualdirectories/<Name> | The content of virtual directories is replaced by the content of target directories. |
Utility resources
These resources aren't exposed directly but are used as parts of Main Resources above
| Name | Description |
|---|
AclEntry | This structure defines allow or deny access for a specific user or user-group. If some user or group ends up having conflicting access levels, most restrictive access takes precedence. |
AttackProtectionSettings | Hack and flood attack protection settings |
Ban | A permanent or temporary ban for some named entity (currently IP or User account). |
FileOwner | Specifies a file/directory owner. |
InetAddress | An IPv4 or IPv6 address or a host name, with optional port part. |
IpRestriction | An entry with an IP address and associated access -- allow or deny. |
Messages | A placeholder for server messages |
Restrictions | Specifies various connection and transfer restrictions. |
SiteCommand | Contains a SITE command that can be executed on FTP access points by issuing 'SITE <command name>'. |