FMAdminMBS.SendMessageToClient(clientID as Integer, messageText as String) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Send a message to a FileMaker client.

You cannot send a message to a client that is connected via FileMaker Data API. You receive an error code of 0 even if the client is connected via FileMaker Data API.

messageText: The text message to send to the client. This parameter cannot be an empty string or a string of whitespace characters.

FMAdminMBS.UpdateDataAPISettings(enabled as Boolean) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the FileMaker Data API settings.

enabled: allows you to enable or disable FileMaker Data API.

FMAdminMBS.UpdatePHPSettings(settings as Dictionary) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the PHP settings. Parameters are optional, but at least one parameter is required.

PHP Configuration dictionary:

characterEncoding	string	Enum: "UTF-8" "ISO-8859-1". The default character encoding for PHP.
dataPreValidation	boolean	Whether the record data should be validated before committing changes to the Database Server.
enabled	boolean	If used with GET, specifies whether Custom Web Publishing with PHP is enabled or disabled. If used with PATCH, allows you to enable or disable Custom Web Publishing with PHP.
errorMessageLanguage	string	Enum: "en" "it" "de" "fr" "ja". The language used for error messages for PHP.
useFileMakerPhp	boolean	Whether to use the FileMaker version of the PHP engine rather than your own version of PHP.

FMAdminMBS.UpdateServerGeneralSettings(settings as Dictionary) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the server general settings. All parameters are optional, but at least one parameter is required.

Provide Server General Settings via dictionary with following keys:

cacheSize	integer >= 64	Cache memory (in megabytes) allocated by the server. The maximum setting is not enforced, but allocating more memory than what the system can manage will impact server performance.
maxFiles	integer [ 1 .. 125 ]	Maximum number of databases that can be hosted.
maxProConnections	integer [ 0 .. 2000 ]	Maximum number of FileMaker Pro client connections.
maxPSOS	integer [ 0 .. 500 ]	Maximum number of script sessions that can run on the server simultaneously.
openDatabasesOnStart	boolean	Automatically open databases that are in the database folders when the Database Server starts.
startupRestorationEnabled	boolean	Enable/Disable database auto restoration. If you change this setting, you need to restart FileMaker Server for the change to take effect.
startupRestorationLogPath	string ^(?!\s*$).+	The folder path to save restoration logs. If you change this setting, you need to restart FileMaker Server for the change to take effect. This parameter cannot be an empty string or a string of whitespace characters.
useSchedules	boolean	Allow enabled schedules to run.
autostartDBS	boolean	Whether the Database Server should start automatically. If autostartDBS is set to false, autostartWPE is also set to false.
autostartWPE	boolean	Whether the Web Publishing Engine should start automatically. If autostartDBS is set to false, autostartWPE can't be set to true.

FMAdminMBS.UpdateServerSecuritySetting(requireSecureDB as Boolean) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the server security setting.

requireSecureDB: If set to true, only databases with password-protected accounts that have the Full Access privilege set can be opened for hosting. Applies only to the default and additional folders.

FMAdminMBS.UpdateServerStatus(status as String, messageText as String = "", graceTime as Integer = -1) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Run or stop the Database Server.

status: "RUNNING" or "STOPPED"
Allows you to start or stop FileMaker Database Server.

messageText: Up to 200 characters. The message to send to the FileMaker client when stopping the Database Server.
graceTime: The length of seconds to delay before stopping the Database Server. Default is 90 and range is 0 to 3600.

If messageText is empty or graceTime is negative, we don't include the value in the request.

FMAdminMBS.UpdateWebDirectSettings(enabled as Boolean) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the FileMaker WebDirect settings.

enabled: allows you to enable or disable FileMaker WebDirect.

FMAdminMBS.UpdateWPESettings(machineID as Integer, enabled as Boolean) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the Web Publishing Engine settings.

machineID	integer >= 1	ID of machine
enabled	boolean	Allows you to enable or disable Web Publishing Engine.

FMAdminMBS.UpdateXDBCSettings(enabled as Boolean) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the ODBC and JDBC settings.

enabled: allows you to enable or disable ODBC/JDBC.

FMAdminMBS.UpdateXMLSettings(enabled as Boolean) as FMResponseMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Update the XML settings.

enabled: allows you to enable or disable XML.