FMAdminMBS.Constructor

FMAdminMBS.CreateBackupSchedule(schedule as Dictionary) as FMResponseMBS

Please pass Backup Schedule as dictionary:

name	string [ 1 .. 31 ] characters ^(?!\s*$).+	Schedule name. This parameter cannot be an empty string or a string of whitespace characters.
backupType	dictionary	Parameters for the backup schedule.
sendEmail	Array of strings	Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.
enabled	boolean	To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.
onceType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.
weeklyType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.
everyndaysType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

FMAdminMBS.CreateFileMakerScriptSchedule(schedule as Dictionary) as FMResponseMBS

The parameter for creating a FileMaker Script Schedule as dictionary:

name	string [ 1 .. 31 ] characters ^(?!\s*$).+	Schedule name. This parameter cannot be an empty string or a string of whitespace characters.
filemakerScriptType	dictionary	Parameters for the FileMaker script schedule.
sendEmail	Array of strings	Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.
enabled	boolean	To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.
onceType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.
weeklyType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.
everyndaysType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

FMAdminMBS.CreateMessageSchedule(schedule as Dictionary) as FMResponseMBS

Create Message Schedule Parameters as dictionary:

name	string [ 1 .. 31 ] characters ^(?!\s*$).+	Schedule name. This parameter cannot be an empty string or a string of whitespace characters.
messageType	dictionary	Parameters for the message schedule.
sendEmail	Array of strings	Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.
enabled	boolean	To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.
onceType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.
weeklyType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.
everyndaysType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

FMAdminMBS.CreateScriptSequenceSchedule(schedule as Dictionary) as FMResponseMBS

Pass Script Sequence Schedule Parameter as dictionary:

name	string [ 1 .. 31 ] characters ^(?!\s*$).+	Schedule name. This parameter cannot be an empty string or a string of whitespace characters.
scriptSequenceType	dictionary	Parameters for the script sequence schedule.
sendEmail	Array of strings	Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.
enabled	boolean	To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.
onceType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.
weeklyType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.
everyndaysType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

FMAdminMBS.CreateSystemScriptSchedule(schedule as Dictionary) as FMResponseMBS

Pass System Script Schedule Parameters as dictionary:

name	string [ 1 .. 31 ] characters ^(?!\s*$).+	Schedule name. This parameter cannot be an empty string or a string of whitespace characters.
systemScriptType	dictionary	Parameters for the system script schedule.
sendEmail	Array of strings	Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.
enabled	boolean	To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.
onceType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.
weeklyType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.
everyndaysType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

FMAdminMBS.CreateVerifySchedule(schedule as Dictionary) as FMResponseMBS

Pass Verify Schedule Parameters as dictionary:

name	string [ 1 .. 31 ] characters ^(?!\s*$).+	Schedule name. This parameter cannot be an empty string or a string of whitespace characters.
verifyType	dictionary	Parameters for the verify schedule.
sendEmail	Array of strings	Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.
enabled	boolean	To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.
onceType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.
weeklyType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.
everyndaysType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

FMAdminMBS.DeleteSchedule(scheduleID as Integer) as FMResponseMBS

scheduleID: ID of the schedule, a value ≥ 2. Schedule ID 1 is reserved by FileMaker Server.

FMAdminMBS.DisconnectClient(ClientID as Integer, messageText as String = "", graceTime as Integer = -1) as FMResponseMBS

ClientID	integer >= 1	ID of the client to disconnect.
messageText	string [ 0 .. 200 ] characters	The text message to send to the client that is being disconnected.
graceTime	integer [ 0 .. 3600 ]	The number of seconds to wait before disconnecting the client. Default: 90

FMAdminMBS.DuplicateSchedule(scheduleID as Integer) as FMResponseMBS

ScheduleID: The schedule ID for the schedule to duplicate, a value ≥ 2. Schedule ID 1 is reserved by FileMaker Server.

FMAdminMBS.EditSchedule(scheduleID as Integer, schedule as Dictionary) as FMResponseMBS

Each parameter is optional, but at least one parameter is required.

To run a schedule, set the 'status' parameter to 'RUNNING'.
Use this call to run a schedule. Use the GetSchedule API call to verify the results.
You can not change schedule type in edit schedule api.

Parameters for dictionary:

name	string [ 1 .. 31 ] characters ^(?!\s*$).+	Schedule name. This parameter cannot be an empty string or a string of whitespace characters.
status	string	Value: "RUNNING". Whether to run the schedule.
onceType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.
weeklyType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.
everyndaysType	dictionary	If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.
sendEmail	Array of strings	Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.
enabled	boolean	To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.
backupType	dictionary	Parameters for the backup schedule.
filemakerScriptType	dictionary	Parameters for the FileMaker script schedule.
messageType	dictionary	Parameters for the message schedule.
scriptSequenceType	dictionary	Parameters for the script sequence schedule.
systemScriptType	dictionary	Parameters for the system script schedule.
verifyType	dictionary	Parameters for the verify schedule.

FMAdminMBS.GetDataAPISettings as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.GetPHPSettings as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.GetSchedule(scheduleID as Integer) as FMResponseMBS

scheduleID: ID of the schedule, value ≥ 2. Schedule ID 1 is reserved by FileMaker Server.

FMAdminMBS.GetServerGeneralSettings as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.GetServerSecuritySetting as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.GetServerStatus as FMResponseMBS

FMAdminMBS.GetWebDirectSettings as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.GetWPESettings as FMResponseMBS

See also:

• GetWPESettings(MachineID as Integer) as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.GetWPESettings(MachineID as Integer) as FMResponseMBS

MachineID: ID of machine, a value ≥ 1.

See also:

• GetWPESettings as FMResponseMBS

FMAdminMBS.GetXDBCSettings as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.GetXMLSettings as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.ListClients as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.ListDatabases as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.ListSchedules as FMResponseMBS

Some examples using this method:

• /FMAPI/FileMaker Admin API Test

FMAdminMBS.Login as FMResponseMBS

Var d As New FMAdminMBS

d.Password = "admin"
d.Username = "admin"
d.Server   = "localhost"

Var r As FMResponseMBS = d.Login

If r = Nil Then
  msgbox "Failed?"
else
  MsgBox r.ErrorMessage
End If

Please either set UserName and Password before calling this.
If you don't call Login explicitly or the session token expired, the plugin will call it for you.

FMAdminMBS.Logout as FMResponseMBS

Clears session token property.

FMAdminMBS.PerformDatabaseOperations(DatabaseID as Integer, status as String, key as string = "",saveKey as boolean = false, messageText as string = "", force as boolean = false) as FMResponseMBS

status	Enum: "OPENED" "PAUSED" "RESUMED" "CLOSED"	Status of the database.
key	string	The password required to open an encrypted database. Required and allowed only if status = OPENED. Note: FileMaker Admin API does not validate the encryption key. You receive an error code of 0 even if you enter an invalid key.
saveKey	boolean	Allow the host to save the encryption password. Allowed only if status = OPENED.
messageText	string [ 0 .. 200 ] characters	The text message to send to the client being disconnected. Required and allowed only if status = CLOSED.
force	boolean	Forces databases to be closed and disconnects connected clients. Overrides the graceTime option. Allowed only if status = CLOSED.

See also:

• PerformDatabaseOperations(status as String, force as boolean = false) as FMResponseMBS

FMAdminMBS.PerformDatabaseOperations(status as String, force as boolean = false) as FMResponseMBS

status: "OPENED", "PAUSED", "RESUMED", "CLOSED". Status of the database.
force: Forces databases to be closed and disconnects connected clients. Overrides the graceTime option. Allowed only if status = CLOSED.

See also:

• PerformDatabaseOperations(DatabaseID as Integer, status as String, key as string = "",saveKey as boolean = false, messageText as string = "", force as boolean = false) as FMResponseMBS

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

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

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

FMAdminMBS.UpdatePHPSettings(settings as Dictionary) as FMResponseMBS

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

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

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

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

enabled: allows you to enable or disable FileMaker WebDirect.

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

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

FMAdminMBS.UpdateXDBCSettings(enabled as Boolean) as FMResponseMBS

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

FMAdminMBS.UpdateXMLSettings(enabled as Boolean) as FMResponseMBS

enabled: allows you to enable or disable XML.