Cerberus SOAP API Reference – Cerberus Support

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

Operations to manage Cerberus native users.

AddUser

Add a user to Cerberus. If the user already exists, it is overwritten.

ChangePassword

Change the password of an existing user.

DeleteUser

Remove a user account.

GetUserInformation

Get all properties of a specified user.

GetUserList

Retrieves the list of all native Cerberus user-names.

RenameUser

Renames an existing user.

GetUserCustomSettings

Retrieves a complete XML representation of users’ custom settings. This includes multi-factor authentication settings and security questions.

SetUserCustomSettings

Sets users’ custom settings given an XML representation of all settings.

Group Management

Operations to manage Cerberus native groups.

AddGroup

Add new group. If the group name already exists, it is overwritten.

DeleteGroup

Remove group.

GetGroupList

Returns the list of all group names.

GetGroupInformation

Get all properties of a specified group.

GetGroups

Returns an XML representation of all group information. Safer alternative is GetGroupList coupled with GetGroupInformation.

RenameGroup

Change the name of an existing group.

Virtual Directory Management

Operations to manage virtual directories on both users and groups.

AddDirectoryToGroup

Add virtual directory to a group.

AddDirectoryToUser

Add a virtual directory to user account.

DeleteDirectoryFromGroup

Remove a virtual directory from a group.

DeleteDirectoryFromUser

Remove a virtual directory from user account.

Interface/Listener Management

Operations to manage interfaces and connections.

GetInterfaceByID

Retrieve the interface definition for the given interface ID.

GetInterfaceList

Retrieve all interface definitions.

GetConnectedUserList

Retrieve list of currently connected users. Results contain both connection ID and interface ID.

GetCurrentConnectionCount

Retreive count of current connections to given interface ID.

GetInterfaces

Retrieve XML block representing all listeners. Safer alternatives are GetInterfaceList and GetInterfacesByID.

InitializeInterface

Start an interface. Returns 'false' if the interface is already started and listening for connections.

ModifyInterface

Modify properties of a given interface.

ShutdownConnectionsOnInterface

Shutdown all connections to the given interface ID.

ShutdownInterface

Shutdown interface. Existing connections are closed.

TerminateConnection

Terminate the given connection ID.

Event Management

Advanced operations to manage event rules.

GetEventRules

Retrieve XML block representing configured Event rules.

SetEventRules

Set event rules with properly structured XML block.

IP Manager

Operations to manage IP whitelist/blacklist functionality.

GetAutoBlockList

Retreives XML block representing auto-blocking settings.

SaveBlockList

Set the IP Manager list with XML block.

AddIp

Add an IP or IP range to the IP Manager.

BlockAddress

Block the given address. Removes from IP manager if in white-list mode, adds if in black-list mode.

DeleteIp

Remove an IP address/range from the IP Manager.

GetIPBlockList

Retrieves the current list of tracked IP addresses/ranges from IP Manager.

Folder Monitor

Advanced operations for managing folder monitoring functionality.

GetFolderMonitors

Retrieves an XML block of all currentently-monitored folders.

SetFolderMonitors

Overwrites current list of monitored folders with supplied XML block.

Reporting Database

Operations related to reporting and the Cerberus statistics database.

BackupStatisticsDatabase

Backup reporting database.

CreateStatisticsDatabase

Create tables on currently-configured statistics database.

DropStatisticsDatabase

Drop tables from configured reporting database.

GenerateStatistics

Generate statistics report. Returns path to report on Cerberus' host.

RestoreStatisticsDatabase

Restore reporting database from backup.

TestAndVerifyDatabase

Connect and verify configured reporting database.

Public Shares

Advanced operations for managing publicly-shared files.

DeletePublicShares

Removes public shares from the server, represented by a list of GUID strings.

GetPublicShares

Retrieves an XML block of all current public shares.

SetPublicShares

Overwrites public shares with supplied XML block.

SharePublicFile

Create a new public-shared file. Requires login and password of a standard user who has access to the file/folder.

Account Requests

Operations for managing the list of requested accounts.

DeleteRequestedAccounts

Delete the specified account requests, identified by list of GUID strings.

GetRequestedAccounts

Retrieve XML block of current account requests.

SetRequestedAccounts

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.

CurrentStatus

Retrieve basic status of Cerberus FTP Server including bandwidth, connections, and start date.

GetAllCurrentConnectionCount

Retrieve current number of active connections.

GetAppPaths

Retrieve Cerberus FTP Server’s working directories.

GetCurrentBandwidth

Retrieve current bandwidth utilization.

GetFeatures

Retrieves list of enabled features and allowed connections.

GetFileTransfers

Retrieve list of files currently in transit.

GetHostname

Get the hostname of the server running Cerberus FTP Server.

GetLicenseInfo

Retrieve detailed license information.

GetLogMessages

Retrieve log messages from the logging queue.

GetStatistics

Retrieve file and connection counts since last restart. Includes number of files uploaded/downloaded, total/current connections, and failed up/downloads.

ServerInformation

Retrieve basic information about Cerberus FTP Server.

ServerSummaryStatus

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.

VerifyLicense

Validates a given license string.

Server Configuration

Low-level operations for configuration

CommitSettings

Commit changes to configuration.

CreateDirectory

Create a directory on the Cerberus server filesystem.

DeleteDirectory

Delete a directory from the Cerberus server filesystem.

GetConfiguration

Retrieve XML block of all server configuration settings.

GetProfiles

Retrieves a complete XML block of all user profiles. GetUserInformation is a safer alternative.

SaveConfiguration

Save server configuration settings in XML format.

SaveProfiles

Write an XML block of all user profiles. AddUser is a safer alternative.

GetAdminAccounts

Retrieve the list of administrator accounts.

GetMimeMappings

Retrieve the file extension to mime-type map.

SaveMimeMappings

Set the file extension to mime-type map.

SetAdminAccounts

Set the list of administrator accounts.

SetWANIP

Set the publicly available IP address.

GetAuthenticationList

Retrieve XML block of authentication providers in order of priority.

SetAuthenticationList

Set the list of authentication providers in XML format.

Backup and Sync

Operation of Cerberus FTP Server's backup and restore facilities.

GetBackupServers

Retrieve XML block representing Cerberus' configured Sync servers.

SaveBackupServers

Set XML block of Cerberus' Sync servers.

BackupServerConfiguration

Creates a backup of the Cerberus FTP Server configuration at the specified location.

RestoreServerConfiguration

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.

InitializeServer

Initializes the server.

ShutdownServer

Shuts down the Cerberus service.

StartServer

Starts Cerberus listeners.

StopServer

Stops Cerberus listeners.

ServerStarted

Checks whether the Cerberus Server has started.