Below is a list of all operations supported by the Cerberus SOAP API as of 10.0.10, grouped by functional domain, along with a short description of the operation.
Internal Operations, colored in red, should not be used. They are used internally by the Cerberus GUI. Misuse may result in server instability and loss of data.
Advanced Operations, colored in orange , are low-level operations whose use is discouraged. They are difficult to use correctly, as they exchange blocks of XML, rather than well-defined objects. Sending malformed XML to these APIs may result in loss of data and services. Safer alternatives are noted where available.
- User Management
- Group Management
- Virtual Directory Management
- Interface/Listener Management
- Event Management
- IP Manager
- Folder Monitor
- Reporting Database
- Public Shares
- Account Requests
- Server Information and Status
- Server Configuration
- Backup and Sync
Operations to manage Cerberus native users.
Add a user to Cerberus. If the user already exists, it is overwritten.
Change the password of an existing user.
Remove a user account.
Get all properties of a specified user.
Retrieves the list of all native Cerberus user-names.
Renames an existing user.
Retrieves a complete XML representation of users’ custom settings. This includes multi-factor authentication settings and security questions.
Sets users’ custom settings given an XML representation of all settings.
Operations to manage Cerberus native groups.
Add new group. If the group name already exists, it is overwritten.
Returns the list of all group names.
Get all properties of a specified group.
Returns an XML representation of all group information. Safer alternative is GetGroupList coupled with GetGroupInformation.
Change the name of an existing group.
Virtual Directory Management
Operations to manage virtual directories on both users and groups.
Add virtual directory to a group.
Add a virtual directory to user account.
Remove a virtual directory from a group.
Remove a virtual directory from user account.
Operations to manage interfaces and connections.
Retrieve the interface definition for the given interface ID.
Retrieve all interface definitions.
Retrieve list of currently connected users. Results contain both connection ID and interface ID.
Retreive count of current connections to given interface ID.
Retrieve XML block representing all listeners. Safer alternatives are GetInterfaceList and GetInterfacesByID.
Start an interface. Returns 'false' if the interface is already started and listening for connections.
Modify properties of a given interface.
Shutdown all connections to the given interface ID.
Shutdown interface. Existing connections are closed.
Terminate the given connection ID.
Advanced operations to manage event rules.
Retrieve XML block representing configured Event rules.
Set event rules with properly structured XML block.
Operations to manage IP whitelist/blacklist functionality.
Retreives XML block representing auto-blocking settings.
Set the IP Manager list with XML block.
Add an IP or IP range to the IP Manager.
Block the given address. Removes from IP manager if in white-list mode, adds if in black-list mode.
Remove an IP address/range from the IP Manager.
Retrieves the current list of tracked IP addresses/ranges from IP Manager.
Advanced operations for managing folder monitoring functionality.
Retrieves an XML block of all currentently-monitored folders.
Overwrites current list of monitored folders with supplied XML block.
Operations related to reporting and the Cerberus statistics database.
Backup reporting database.
Create tables on currently-configured statistics database.
Drop tables from configured reporting database.
Generate statistics report. Returns path to report on Cerberus' host.
Restore reporting database from backup.
Connect and verify configured reporting database.
Advanced operations for managing publicly-shared files.
Removes public shares from the server, represented by a list of GUID strings.
Retrieves an XML block of all current public shares.
Overwrites public shares with supplied XML block.
Create a new public-shared file. Requires login and password of a standard user who has access to the file/folder.
Operations for managing the list of requested accounts.
Delete the specified account requests, identified by list of GUID strings.
Retrieve XML block of current account requests.
Set XML block of account requests.
Server Information and Status
These operations provide information about server configuration and retrieve current statistics on the server's run-time state.
Retrieve basic status of Cerberus FTP Server including bandwidth, connections, and start date.
Retrieve current number of active connections.
Retrieve Cerberus FTP Server’s working directories.
Retrieve current bandwidth utilization.
Retrieves list of enabled features and allowed connections.
Retrieve list of files currently in transit.
Get the hostname of the server running Cerberus FTP Server.
Retrieve detailed license information.
Retrieve log messages from the logging queue.
Retrieve file and connection counts since last restart. Includes number of files uploaded/downloaded, total/current connections, and failed up/downloads.
Retrieve basic information about Cerberus FTP Server.
Retrieve overview of Cerberus FTP Server status and configuration. Includes all information from Cerberus' "Server Configuration and Status Summary" page displayed in the main GUI.
Validates a given license string.
Low-level operations for configuration
Commit changes to configuration.
Create a directory on the Cerberus server filesystem.
Delete a directory from the Cerberus server filesystem.
Retrieve XML block of all server configuration settings.
Retrieves a complete XML block of all user profiles. GetUserInformation is a safer alternative.
Save server configuration settings in XML format.
Write an XML block of all user profiles. AddUser is a safer alternative.
Retrieve the list of administrator accounts.
Retrieve the file extension to mime-type map.
Set the file extension to mime-type map.
Set the list of administrator accounts.
Set the publicly available IP address.
Retrieve XML block of authentication providers in order of priority.
Set the list of authentication providers in XML format.
Backup and Sync
Operation of Cerberus FTP Server's backup and restore facilities.
Retrieve XML block representing Cerberus' configured Sync servers.
Set XML block of Cerberus' Sync servers.
Creates a backup of the Cerberus FTP Server configuration at the specified location.
Restores Cerberus configuration from backup.
Startup and Shutdown
These operations are for internal use. Do not use these operations. Incorrect use may cause server instability and loss of service.
Use operating system facilities to start and stop the Cerberus service.
Initializes the server.
Shuts down the Cerberus service.
Starts Cerberus listeners.
Stops Cerberus listeners.
Checks whether the Cerberus Server has started.