Claris FileMaker Server Admin API
The FileMaker Admin API is an application programming interface (API) that allows web services to perform administrative tasks on FileMaker Cloud and FileMaker Server through scripting instead of using Admin Console. Because this API conforms to Representational State Transfer (REST) architecture, the Admin API is a REST API.
Actions
Action |
Configuration fields |
Data type |
Required? |
---|---|---|---|
Create FileMaker script schedule - Creates a FileMaker script schedule |
Timeout - A time limit, in minutes, to allow the script to run. A timeout of '0' means there is no time limit. If you create a schedule without specifying this parameter, the default value '2' is used. |
String |
|
Days of the week - The abbreviation for each day of the week to run the schedule. Possible values: "SUN", "MON", "TUE", "WED", "THU", "FRI", and "SAT". |
|
|
|
Daily end date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
End date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily start time - The daily schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Send email - The email addresses to send notifications to. An empty value disables sending emails. Note: SMTP configuration is required for sending emails. |
|
|
|
Resource - The FileMaker database name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script account - The FileMaker database script account name |
String |
|
|
FileMaker script name - The FileMaker database script name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script param - The FileMaker database script parameter |
String |
|
|
FileMaker script password - The FileMaker database script password |
String |
|
|
Daily days - The interval between days on which to run the schedule. For example, a value of 3 repeats the schedule every 3 days. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
Schedule name - The name of the schedule. Can't be an empty string or a string of whitespace characters. |
String |
|
|
Daily repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Daily repeat interval is in minutes or from 1 to 24 when Daily repeat interval is in hours. |
String |
|
|
Weekly repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Repeat internal is in minutes or from 1 to 24 when Repeat interval is in hours. |
String |
|
|
End date - The schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Start timestamp - The schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly end date - The weekly schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Weekly start timestamp - The weekly schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Auto abort - Whether to abort the schedule if the time limit is reached or FileMaker Server stops. If you create a schedule without specifying this parameter, the default value 'false' is used. |
Boolean |
|
|
Enabled - Whether 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. |
Boolean |
|
|
Create script sequence schedule - Creates a script sequence schedule |
Timeout - A time limit, in minutes, to allow the script to run. A timeout of '0' means there is no time limit. If you create a schedule without specifying this parameter, the default value '2' is used. |
String |
|
Days of the week - The abbreviation for each day of the week to run the schedule. Possible values: "SUN", "MON", "TUE", "WED", "THU", "FRI", and "SAT". |
|
|
|
Daily end date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
End date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily start time - The daily schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Send email - The email addresses to send notifications to. An empty value disables sending emails. Note: SMTP configuration is required for sending emails. |
|
|
|
Resource - The FileMaker database folder path (DB_IN_FOLDER) or FileMaker database name (SINGLE_DB). Allowed and required only if the Resource type chosen is either DB_IN_FOLDER or SINGLE_DB. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script account - The FileMaker database script account name |
String |
|
|
FileMaker script name - The FileMaker database script name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script param - The FileMaker database script parameter |
String |
|
|
FileMaker script password - The FileMaker database script password |
String |
|
|
Daily days - The interval between days on which to run the schedule. For example, a value of 3 repeats the schedule every 3 days. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
OS script post-processing - The name and full path of the post-processing system script. Specifying 'osScript' or 'osScript2' is required, and at least one of them must be provided. |
String |
|
|
OS script - The name and full path of the pre-processing system script. Specifying 'osScript' or 'osScript2' is required, and at least one of them must be provided. |
String |
|
|
Schedule name - The name of the schedule. Can't be an empty string or a string of whitespace characters. |
String |
|
|
Daily repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Daily repeat interval is in minutes or from 1 to 24 when Daily repeat interval is in hours. |
String |
|
|
Weekly repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Repeat internal is in minutes or from 1 to 24 when Repeat interval is in hours. |
String |
|
|
OS script param - The Parameter of the pre-processing system script |
String |
|
|
OS script param post-processing - The post-processing system script parameter |
String |
|
|
End date - The schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Start timestamp - The schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
OS script account - The user account name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
OS script password - The user account password. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Weekly end date - The weekly schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Weekly start timestamp - The weekly schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Auto abort - Whether to abort the schedule if the time limit is reached or FileMaker Server stops. If you create a schedule without specifying this parameter, the default value 'false' is used. |
Boolean |
|
|
Enabled - Whether 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. |
Boolean |
|
|
Create system script schedule - Creates a system script schedule |
Timeout - A time limit, in minutes, to allow the script to run. A timeout of '0' means there is no time limit. If you create a schedule without specifying this parameter, the default value '2' is used. |
String |
|
Days of the week - The abbreviation for each day of the week to run the schedule. Possible values: "SUN", "MON", "TUE", "WED", "THU", "FRI", and "SAT". |
|
|
|
Daily end date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
End date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily start time - The daily schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Send email - The email addresses to send notifications to. An empty value disables sending emails. Note: SMTP configuration is required for sending emails. |
|
|
|
Daily days - The interval between days on which to run the schedule. For example, a value of 3 repeats the schedule every 3 days. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
OS script - The name and full path of the system script. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Schedule name - The name of the schedule. Can't be an empty string or a string of whitespace characters. |
String |
|
|
Daily repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Daily repeat interval is in minutes or from 1 to 24 when Daily repeat interval is in hours. |
String |
|
|
Weekly repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Repeat internal is in minutes or from 1 to 24 when Repeat interval is in hours. |
String |
|
|
End date - The schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Start timestamp - The schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
OS script account - The user account name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
OS script password - The user account password. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Weekly end date - The weekly schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Weekly start timestamp - The weekly schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Auto abort - Whether to abort the schedule if the time limit is reached or FileMaker Server stops. If you create a schedule without specifying this parameter, the default value 'false' is used. |
Boolean |
|
|
Enabled - Whether 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. |
Boolean |
|
|
Edit/Run schedule - Edit/Run a schedule |
Schedule ID - The ID of the schedule. Schedule ID 1 is reserved by FileMaker Server. |
String |
|
FileMaker script sequence schedule timeout - A time limit, in minutes, to allow the script to run. A timeout of `0` means there is no time limit. If you create a schedule without specifying this parameter, the default value '2' is used. |
String |
|
|
FileMaker script schedule timeout - A time limit, in minutes, to allow the script to run. A timeout of `0` means there is no time limit. If you create a schedule without specifying this parameter, the default value 2 is used. |
String |
|
|
System script schedule timeout - A time limit, in minutes, to allow the script to run. A timeout of `0` means there is no time limit. If you create a schedule without specifying this parameter, the default value 2 is used. |
String |
|
|
Backup schedule resource type - Choose the resource type of the backup schedule |
Choice |
|
|
Message resource type - Choose the resource type of the message |
Choice |
|
|
Verify schedule resource type - Choose the resource type of the verify schedule |
Choice |
|
|
Backup schedule resource - FileMaker database folder path (DB_IN_FOLDER) or FileMaker database name (SINGLE_DB). Allowed only and required if the Resource type is DB_IN_FOLDER or SINGLE_DB. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Message schedule resource - FileMaker database folder path (DB_IN_FOLDER) or FileMaker database name (SINGLE_DB). Allowed only and required if the Resource type is DB_IN_FOLDER or SINGLE_DB. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Days of the week - The abbreviation for each day of the week to run the schedule. Possible values: "SUN", "MON", "TUE", "WED", "THU", "FRI", and "SAT". |
|
|
|
Backup schedule target - The backup folder path. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Daily end date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
End date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily start time - The daily schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Send email - The email addresses to send notifications to. An empty value disables sending emails. Note: SMTP configuration is required for sending emails. |
|
|
|
Verify schedule resource - The FileMaker database folder path (DB_IN_FOLDER) or FileMaker database name (SINGLE_DB). Allowed only and required if the Resource type DB_IN_FOLDER or SINGLE_DB. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script schedule resource - The FileMaker database name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script sequence schedule resource - The FileMaker database name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script schdeule account - The FileMaker database script account name |
String |
|
|
FileMaker script sequence schedule account - The FileMaker database script account name |
String |
|
|
FileMaker script schedule name - The FileMaker database script name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script sequence schedule name - The FileMaker database script name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script schedule parameter - The FileMaker database script parameter |
String |
|
|
FileMaker script sequence schedule parameter - The FileMaker database script parameter |
String |
|
|
FileMaker script schedule password - The FileMaker database script password |
String |
|
|
FileMaker script sequence schedule password - The FileMaker database script password |
String |
|
|
Daily days - The interval between days on which to run the schedule. For example, a value of 3 repeats the schedule every 3 days. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
Max backups - The maximum number of backups to keep. If you create a schedule without specifying this parameter, the default value '1' is used. |
String |
|
|
FileMaker script sequence schedule OS script post-processing - The name and full path of the post-processing system script. Specifying 'osScript' or 'osScript2' is required, and at least one of them must be provided. |
String |
|
|
FileMaker script sequence schedule OS script - The name and full path of the pre-processing system script. Specifying 'osScript' or 'osScript2' is required, and at least one of them must be provided. |
String |
|
|
System script schedule OS script - The name and full path of the system script. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Schedule name - The name of the schedule. Can't be an empty string or a string of whitespace characters. |
String |
|
|
Verify schedule time delay - The number of minutes to delay before closing the database. If you create a schedule without specifying this parameter, the default value 2 is used. |
String |
|
|
Daily repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Daily repeat interval is in minutes or from 1 to 24 when Daily repeat interval is in hours. |
String |
|
|
Weekly repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Repeat internal is in minutes or from 1 to 24 when Repeat interval is in hours. |
String |
|
|
FileMaker script sequence schedule OS script parameter - The parameter of the pre-processing system script |
String |
|
|
FileMaker script sequence schedule OS script post-processing parameter - The post-processing system script parameter |
String |
|
|
End date - The schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Start timestamp - The schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Schedule status - The status of the schedule. Set value to "RUNNING" to run the schedule. |
String |
|
|
Message schedule text - The text message to send to the client. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Verify schedule message text - The text message to send to the client. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Daily repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
FileMaker script sequence schedule OS script account - The user account name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
System script schedule OS script account - The user account name. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
FileMaker script sequence schedule OS script password - The user account password. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
System script schedule OS script password - The user account password. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Weekly end date - The weekly schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Weekly start timestamp - The weekly schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
FileMaker script schedule auto abort - Whether to abort the schedule if the time limit is reached or FileMaker Server stops. If you create a schedule without specifying this parameter, the default value 'false' is used. |
Boolean |
|
|
FileMaker script sequence schedule auto abort - Whether to abort the schedule if the time limit is reached or FileMaker Server stops. If you create a schedule without specifying this parameter, the default value 'false' is used. |
Boolean |
|
|
System script schedule auto abort - Whether to abort the schedule if the time limit is reached or FileMaker Server stops. If you create a schedule without specifying this parameter, the default value `false` is used. |
Boolean |
|
|
Clone backup - Whether to create a clone of the backup file. If you create a schedule without specifying this parameter, the default value 'fals' is used. |
Boolean |
|
|
Enabled - Whether 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. |
Boolean |
|
|
Verify backup - Whether to perform a consistency check. If you create a schedule without specifying this parameter, the default value 'false' is used. Note: Enabling this option can detect errors in the backup file. However, backup operations that have this option enabled can take much longer to complete and may slow other activities on the master machine. |
Boolean |
|
|
Change database status - Changes the status of a database on the host |
Database ID - Enter the ID of the database |
String |
|
Save Key - Allow the host to save the encryption password. Allowed only if status = OPENED. |
Boolean |
|
|
Status - Choose a status |
Choice |
|
|
Force - Forces databases to be closed and disconnects connected clients. Overrides the graceTime option. Allowed only if status = CLOSED. |
Boolean |
|
|
Key - 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. |
String |
|
|
Text message - The text message to send to the client being disconnected. Required and allowed only if status = CLOSED. |
String |
|
|
Create verify schedule - Creates a verify schedule |
Database type - Choose a database type |
Choice |
|
Days of the week - The abbreviation for each day of the week to run the schedule. Possible values: "SUN", "MON", "TUE", "WED", "THU", "FRI", and "SAT". |
|
|
|
Daily end date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
End date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily start time - The daily schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Send email - The email addresses to send notifications to. An empty value disables sending emails. Note: SMTP configuration is required for sending emails. |
|
|
|
Resource - The FileMaker database folder path (DB_IN_FOLDER) or FileMaker database name (SINGLE_DB). Allowed and required only if the Resource type chosen is either DB_IN_FOLDER or SINGLE_DB. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Daily days - The interval between days on which to run the schedule. For example, a value of 3 repeats the schedule every 3 days. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
Message text - The message to send to the client. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Schedule name - The name of the schedule. Can't be an empty string or a string of whitespace characters. |
String |
|
|
Time delay - The number of minutes to delay before closing the database. If you create a schedule without specifying this parameter, the default value '2' is used. |
String |
|
|
Daily repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Daily repeat interval is in minutes or from 1 to 24 when Daily repeat interval is in hours. |
String |
|
|
Weekly repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Repeat internal is in minutes or from 1 to 24 when Repeat interval is in hours. |
String |
|
|
End date - The schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Start timestamp - The schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly end date - The weekly schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Weekly start timestamp - The weekly schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Enabled - Whether 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. |
Boolean |
|
|
Create backup schedule - Creates a backup schedule |
Resource type - Choose a resource type |
Choice |
|
Days of the week - The abbreviation for each day of the week to run the schedule. Possible values: "SUN", "MON", "TUE", "WED", "THU", "FRI", and "SAT". |
|
|
|
Daily end date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
End date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily start time - The daily schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Send email - The email addresses to send notifications to. An empty value disables sending emails. Note: SMTP configuration is required for sending emails. |
|
|
|
Resource - The FileMaker database folder path (DB_IN_FOLDER) or FileMaker database name (SINGLE_DB). Allowed and required only if the Resource type chosen is either DB_IN_FOLDER or SINGLE_DB. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Daily days - The interval between days on which to run the schedule. For example, a value of 3 repeats the schedule every 3 days. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
Max backups - The maximum number of backups to keep. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
Schedule name - The name of the schedule. Can't be an empty string or a string of whitespace characters. |
String |
|
|
Daily repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Daily repeat interval is in minutes or from 1 to 24 when Daily repeat interval is in hours. |
String |
|
|
Weekly repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Repeat internal is in minutes or from 1 to 24 when Repeat interval is in hours. |
String |
|
|
Backup target - The path to the backup folder. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
End date - The schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Start timestamp - The schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly end date - The weekly schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Weekly start timestamp - The weekly schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Clone - Whether to create a clone of the backup file. If you create a schedule without specifying this parameter, the default value 'false' is used. |
Boolean |
|
|
Enabled - Whether 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. |
Boolean |
|
|
Verify - Whether to verify the backup. If you create a schedule without specifying this parameter, the default value 'false' is used. |
Boolean |
|
|
Create message schedule - Creates a message schedule |
Resource type - Choose a resource type |
Choice |
|
Days of the week - The abbreviation for each day of the week to run the schedule. Possible values: "SUN", "MON", "TUE", "WED", "THU", "FRI", and "SAT". |
|
|
|
Daily end date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
End date - The daily schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Daily start time - The daily schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Send email - The email addresses to send notifications to. An empty value disables sending emails. Note: SMTP configuration is required for sending emails. |
|
|
|
Resource - The FileMaker database folder path (resourceType = DB_IN_FOLDER) or FileMaker database name (resourceType = SINGLE_DB). Allowed only and required if resourceType = DB_IN_FOLDER or SINGLE_DB. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Daily days - The interval between days on which to run the schedule. For example, a value of 3 repeats the schedule every 3 days. If you create a schedule without specifying this parameter, the default value 1 is used. |
String |
|
|
Schedule name - The name of the schedule. Can't be an empty string or a string of whitespace characters. |
String |
|
|
Daily repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Daily repeat interval is in minutes or from 1 to 24 when Daily repeat interval is in hours. |
String |
|
|
Weekly repeat frequency - The number of times to repeat the schedule within a day. Value must be an integer from 1 to 60 when Repeat internal is in minutes or from 1 to 24 when Repeat interval is in hours. |
String |
|
|
End date - The schedule end date. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Start timestamp - The schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Message text - The text message to send to the client. This parameter cannot be an empty string or a string of whitespace characters. |
String |
|
|
Daily repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly repeat interval - The time interval for repeating the schedule. Enter either "MINUTES" or "HOURS". |
String |
|
|
Weekly end date - The weekly schedule end date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Weekly start timestamp - The weekly schedule start date and time. Enter in 24-hour format (yyyy-mm-ddThh:mm:ss). |
String |
|
|
Enabled - Whether 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. |
Boolean |
|
|
Change status of all databases - Changes the status of all databases on the host |
Status - Choose a status |
Choice |
|
Force - Whether to force databases to close and disconnect connected clients. Overrides the Grace time option. Allowed only if Status is set to `Closed`. |
Boolean |
|
|
Set authenticated stream setting - Sets the streaming URL cookie check setting |
Secure DB - Choose whether to check cookies. Use cookie check: 1; No cookie check: 2. |
Number |
|
Change server status - Runs or stops the Database Server |
Status - If used with GET, specifies whether the FileMaker Database Server is running. If used with PATCH, allows you to start or stop the FileMaker Database Server. |
Choice |
|
Update server general settings - Updates the server general settings |
Cache size - The 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. Max: 1024. |
Number |
|
Max files - The maximum number of databases that can be hosted. Max: 125. |
Number |
|
|
Max Pro connections - The maximum number of FileMaker Pro client connections. Max: 2000. |
Number |
|
|
Max PSOS - The maximum number of script sessions that can run on the server simultaneously. Max: 500. |
Number |
|
|
Autostart DBS - Whether the Database Server should start automatically. If set to false, Autostart WPE is also set to false. |
Boolean |
|
|
Autostart WPE - Whether the Web Publishing Engine should start automatically. If Autostart DBS is set to false, Autostart WPE can`t be set to true. |
Boolean |
|
|
Use schedules - Whether to allow enabled schedules to run |
Boolean |
|
|
Open databases on start - Whether to automatically open databases that are in the database folders when the Database Server starts |
Boolean |
|
|
Update Admin Console account - Change the Admin Console account user name and password |
Current password - The current password |
String |
|
Current username - The current user name |
String |
|
|
New password - The new password |
String |
|
|
New username - The new user name |
String |
|
|
Send message to client - Sends a message to a client |
Client ID - Enter the ID of the client |
String |
|
Message text - The message to send to the client |
String |
|
|
Change server name - Changes the database server name |
Server name - The new name of the server |
String |
|
Enable/Disable server additional database folder setting - Enables or disables the additional database folder setting for the server |
Database root path - The path of the additional database folder |
String |
|
Database root path1_RC - THe root path of the additional remote container |
String |
|
|
Backup database root1_RC - Whether to create a backup for the additional remote container folder |
Boolean |
|
|
Use other database root - Whether to enable an additional database folder |
Boolean |
|
|
Use database root1_RC - Whether to enable an additional remote container folder |
Boolean |
|
|
Update server default backup folder path - Updates the server default backup folder path for the server |
Backup path - The server default backup folder path |
String |
|
Update server progressive backup folder path - Updates the server progressive backup folder path |
Progressive backup path - The server progressive backup folder path |
String |
|
Enable/Disable server discovery setting - Enables or disables server discovery by FileMaker Pro and FileMaker Go clients |
Server discovery - Whether FileMaker Pro and FileMaker Go can discover the server |
Boolean |
|
Update server security setting - Updates the server security setting |
Secure DB - Whether 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. |
Boolean |
|
Update server progressive backups setting - Updates the server progressive backups setting |
Incremental backup enabled - Whether progressive backups are enabled |
Boolean |
|
Change status of FileMaker Data API settings - Changes the status FileMaker Data API settings |
Enabled - Whether to enable the FileMaker Data API |
Boolean |
|
Change status of OData API settings - Changes the status of OData API settings |
Enabled - Whether to enable the OData API |
Boolean |
|
Delete schedule - Deletes a schedule |
Schedule ID - The ID of the schedule. Schedule ID 1 is reserved by FileMaker Server. |
String |
|
Disconnect client - Disconnects a client |
Client ID - Enter the ID of the client |
String |
|
Message text - The message to send to the client that is being disconnected |
String |
|
|
Grace time - The number of seconds to wait before disconnecting the client. Default: 90 seconds. |
String |
|
|
Duplicate schedule - Duplicate a schedule specified by the schedule ID |
Schedule ID - The ID of the schedule. Schedule ID 1 is reserved by FileMaker Server. |
String |
|
Get all clients - Return all clients |
|
|
|
Get all databases - Return all databases |
|
|
|
Get all schedules - Returns a list of all schedules |
|
|
|
Get schedule - Returns a schedule |
Schedule ID - The ID of the schedule. Schedule ID 1 is reserved by FileMaker Server. |
String |
|
Get authenticated stream setting - Returns authenticated stream setting |
|
|
|
Get FileMaker Data API usage - Returns FileMaker Data API usage |
|
|
|
Get server additional database folder path - Returns the additional database folder path for the server |
|
|
|
Get server additional remote container folder path - Returns the additional remote container folder path for the server |
|
|
|
Get server current folder setting - Returns the current folder settings for the server |
|
|
|
Get FileMaker Data API settings - Returns the FileMaker Data API settings |
|
|
|
Get OData API settings - Returns the OData API settings |
|
|
|
Get progressive backup folder path for the server - Returns the progressive backup folder path for the server |
|
|
|
Get backup folder path for the server - Returns the server backup folder path |
|
|
|
Get server general setting - Returns the server general setting |
|
|
|
Get server metadata - Returns the server metadata |
|
|
|
Get server security setting - Returns the server security setting |
|
|
|
Get server status - Returns the server status |
|
|
|