Claris FileMaker Cloud 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 |
|
|
|
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 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 |
|
|
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 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 database - Deletes a database |
Database - Choose a database |
Choice |
|
|
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 databases - Return all databases |
|
|
|
|
Get all clients - Returns a list of all clients |
|
|
|
|
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 settings - Returns the FileMaker Data API settings |
|
|
|
|
Get OData API settings - Returns the OData API settings |
|
|
|
