List of Admin API calls

The following table displays the supported API calls for FileMaker Server and FileMaker Cloud. For detailed information about the API calls, see Admin API Reference information.

API call	FileMaker Server	FileMaker Cloud
Authentication
Get restricted access	Yes	No
Update restricted access	Yes	No
Request access token	Yes	Yes
Invalidate access token	Yes	Yes
Authentication	No	Partial¹
Database Server
Get server metadata	Yes	No
Update Admin Console account	Yes	No
Update server name	Yes	No
Get server status	Yes	No
Update server status	Yes	No
Get administrator contact information	Yes	No
Update administrator contact information	Yes	No
Get administrator roles server setting	Yes	No
Create administrator role server setting	Yes	No
Update administrator role server setting	Yes	No
Delete administrator roles server setting	Yes	No
Get server security setting	Yes	No
Update server security setting	Yes	No
Get server general settings	Yes	No
Update server general settings	Yes	No
Update server progressive backups setting	Yes	No
Cancel currently running backup	Yes	No
Enable/disable server additional database folder settings	Yes	No
Enable/disable server discovery setting	Yes	No
Get authenticated stream setting	Yes	Yes
Set authenticated stream setting	Yes	Yes
Allow certificate with unknown revocation status (get)	Yes	No
Allow certificate with unknown revocation status (update)	Yes	No
Get server parallel backup setting	Yes	No
Update server parallel backup setting	Yes	No
Get restrict access	Yes	No
Update restrict access	Yes	No
Get FileMaker Admin API public keys server setting	Yes	No
Add FileMaker Admin API public key server setting	Yes	No
Update FileMaker Admin API public keys server setting	Yes	No
Delete FileMaker Admin API public keys	Yes	No
Get persistent cache setting	Yes	No
Set persistent cache setting	Yes	No
Get block new users setting	Yes	No
Set block new users setting	Yes	No
Get server current folder settings	Yes	No
Get server additional database folder paths	Yes	No
Get server additional remote container folder paths	Yes	No
Get server backup folder path	Yes	No
Update server default backup folder path	Yes	No
Get server progressive backup folder path	Yes	No
Update server progressive backup folder path	Yes	No
Databases
List databases	Yes	Yes
Perform database operations for all databases	Yes	Yes
Perform database operations for a database	Yes	Yes
Remove a database	Yes	Yes
Download database	Yes	Yes
Upload database	Yes	No
Client management
List clients	Yes	Yes
Send message to client	Yes	Yes
Disconnect client	Yes	Yes
Schedules
List schedules	Yes	Yes
Duplicate schedule	Yes	Yes
Create backup schedule	Yes	No
Create FileMaker script schedule	Yes	Partial²
Create message schedule	Yes	Partial³
Create script sequence schedule	Yes	No
Create system script schedule	Yes	No
Create verify schedule	Yes	No
Get schedule	Yes	Yes
Edit/Run schedule	Yes	Partial²
Delete schedule	Yes	Yes
PHP
PHP settings	Yes	No
Update PHP settings	Yes	No
XML
XML settings	Yes	No
Update XML settings	Yes	No
ODBC/JDBC
ODBC/JDBC settings	Yes	No
Update ODBC/JDBC settings	Yes	No
FileMaker Data API
FileMaker Data API usage	Yes	No
FileMaker Data API settings	Yes	Yes
Update FileMaker Data API settings	Yes	Yes
Web Publishing Engine
FileMaker WebDirect settings	Yes	No
Update FileMaker WebDirect settings	Yes	No
WPE settings for all machines	Yes	No
WPE settings for a single machine	Yes	No
Update WPE settings	Yes	No
Get Nginx load balancer URL setting	Partial⁴	No
Update Nginx load balancer URL setting	Partial⁴	No
Get maximum number of CWP connections setting	Yes	No
Update maximum number of CWP connections setting	Yes	No
OData
OData settings	Yes	Yes
Update OData settings	Yes	Yes
License
Get license information	Yes	No
Import license	Yes	No
Sync up license	Yes	No
Notifications
Enable/disable email notifications	Yes	No
Get email notification settings	Yes	No
Update email notification settings	Yes	No
External authentication
Get external account group name	Yes	No
Update external account group name	Yes	No
Get Amazon identity provider information	Yes	No
Update Amazon identity provider information	Yes	No
Get Google identity provider information	Yes	No
Update Google identity provider information	Yes	No
Get Microsoft identity provider information	Yes	No
Update Microsoft identity provider information	Yes	No
Get custom OAuth identity provider information	Yes	No
Update custom OAuth identity provider information	Yes	No
Get AppleID identity provider information	Yes	No
Update AppleID identity provider information	Yes	No
Enable/Disable Admin Console sign-in	Yes	No
Get database sign-in settings for external server accounts	Yes	No
Update database sign-in settings for external server accounts	Yes	No
Get database sign-in settings for Amazon	Yes	No
Update database sign-in settings for Amazon	Yes	No
Get database sign-in settings for Google	Yes	No
Update database sign-in settings for Google	Yes	No
Get database sign-in settings for Microsoft	Yes	No
Update database sign-in settings for Microsoft	Yes	No
Get database sign-in settings for AppleID	Yes	No
Update database sign-in settings for AppleID	Yes	No
Get database sign-in settings for custom OAuth	Yes	No
Update database sign-in settings for custom OAuth	Yes	No
FileMaker client settings
FileMaker Pro and FileMaker Go session timeout setting	Yes	No
Update FileMaker Pro and FileMaker Go session timeout	Yes	No
FileMaker WebDirect session timeout setting	Yes	No
Update FileMaker WebDirect session timeout	Yes	No
Get database filtering setting	Yes	No
Enable/Disable Database filtering	Yes	No
SSL certificate
Create SSL CSR	Yes	No
Get server certificate information	Yes	No
Import SSL certificate	Yes	No
Delete SSL certificate	Yes	No
FMPlugins
Get plug-in list	Yes	No
Enable/disable individual plug-in	Yes	No
Enable/disable WPE install plug-in script	Yes	No
Enable/disable WPE plug-ins	Yes	No
Enable/disable DBS install plug-ins script	Yes	No
Enable/disable DBS plug-ins	Yes	No
Enable/disable DAPI install plug-in script	Yes	No
Enable/disable DAPI plug-ins	Yes	No
Get DBS plug-in configuration	Yes	No
Get WPE plug-in configuration	Yes	No
Get DAPI plug-in configuration	Yes	No
Custom app update
Update	No	Yes
Custom app upload
Get database upload info	No	Yes
Check file upload	No	Yes
Database upload event	No	Yes
Upload	No	Yes
Append (deprecated)	No	Yes
Append multiple parts	No	Yes
Invite users to a team and add users to a group
Invite users to a team	No	Yes
Add users to a group	No	Yes

Used only for custom app update and upload API calls in FileMaker Cloud.
The sendEmail parameter is not supported.
The sendEmail parameter and the DB_IN_FOLDER value for the resourceType parameter are not supported.
Nginx load balancing is only supported on FileMaker Server on Linux.

Notes

FileMaker Cloud uses the UTC time for the startTimeStamp parameter.
For filemakerScriptType, you need to provide both the fmScriptAccount and the fmScriptPassword parameters for the script to run.
In FileMaker Cloud, for filemakerScriptType, use the fmScriptAccount parameter to specify the Claris ID token and the fmScriptPassword parameter to specify the Claris ID refresh token. If you don't specify the refresh token, the script can't run after the Claris ID token is expired. To learn how to generate the token, see Claris Customer Console Help.
When using the FileMaker Admin API to create schedules, the FileMaker Admin API may not validate some values specified in the API request (for example, accounts or passwords).
The Get Schedule call requires the schedule_id parameter. To find a schedule ID, use the Get Schedules call to list all schedules and their settings.
If the returned value for the status parameter for the List Databases call is Normal, the database is open.
API calls related to databases and schedule API calls except for the create and edit/run schedule calls are asynchronous and do not wait for a response from FileMaker Cloud or FileMaker Server. You may want to follow an asynchronous call with a GET call to confirm the file status has changed. For example, follow a close database call with a GET databases call to confirm the database is closed. If the status doesn't change immediately, continue checking. The rest of the API calls are synchronous and wait for a response from FileMaker Cloud or FileMaker Server.
The Upload Database call does not support uploading external container data and will only upload the database.