The FileMaker Server Admin API is a REST API that allows developers and administrators to manage a FileMaker Server deployment programmatically.
In practical terms, it makes it possible to perform many of the operations available in the FileMaker Server Admin Console from another application, a script, a monitoring system, or a hosting platform.
Instead of signing in to the Admin Console and carrying out each task manually, software can send secure HTTPS requests to FileMaker Server and receive responses in JSON format.
What Is the Admin API Used For?
The Admin API is designed for server administration and automation. It can be used to build tools that monitor, configure, or manage one or several FileMaker Server instances.
Depending on the version of FileMaker Server, available operations include:
- listing, opening, pausing, resuming, and closing hosted FileMaker files;
- viewing and disconnecting connected clients;
- creating and managing scheduled tasks;
- running FileMaker scripts;
- monitoring server status and configuration;
- managing backups and server settings;
- retrieving logs and usage information;
- managing plug-ins, certificates, and other server components.
Claris maintains a complete list of FileMaker Admin API calls, including which operations are available for FileMaker Server and FileMaker Cloud.
The exact endpoints supported may change between FileMaker Server versions. The API reference installed on the server therefore remains the authoritative source for a particular deployment.
Admin API vs. Data API
The FileMaker Admin API should not be confused with the FileMaker Data API.
The FileMaker Data API gives an external application access to records stored in FileMaker databases. It can be used to find, create, edit, and delete data.
The FileMaker Admin API manages the server hosting those databases. It works with files, clients, schedules, backups, services, and server configuration.
A simple way to remember the distinction is:
- Data API: work with the information inside a FileMaker solution.
- Admin API: administer the FileMaker Server environment.
The two APIs can be used together, but they serve different purposes.
How Does It Work?
An application sends an HTTPS request to the FileMaker Server Admin API. The request specifies an action using a standard HTTP method such as GET, POST, PATCH, PUT, or DELETE.
FileMaker Server processes the request and returns a response, generally in JSON format.
Before performing administrative operations, the application must authenticate with the server. FileMaker Server can issue an access token that is then included in subsequent requests. Current versions also support PKI-based authentication as an alternative to using the administrator’s username and password directly.
Because the Admin API provides access to sensitive server operations, it should be used only over HTTPS, with credentials and tokens stored securely.
Why Use the FileMaker Admin API?
The principal advantage of the Admin API is automation.
For an organization operating a single FileMaker Server, it can simplify recurring administrative or monitoring tasks. For a hosting provider managing many servers, it becomes an important component of a centralized management platform.
Typical uses include:
- creating a custom server-management dashboard;
- checking whether databases and services are available;
- automating the deployment or maintenance of hosted files;
- integrating FileMaker Server monitoring with external systems;
- managing multiple FileMaker Server instances from one application;
- giving customers access to selected administrative operations without providing full access to the Admin Console.
At fmcloud.fm, this type of automation is fundamental to managing FileMaker hosting at scale. It allows server operations to be integrated into a customer-facing platform while keeping the underlying infrastructure centrally controlled.
Is the Admin API a Replacement for Admin Console?
Not really, although fmcloud.fm’s console use it extensively. (Available with our Pro and Starter plans)
Admin Console remains the standard graphical interface for administering FileMaker Server. It is convenient for interactive management and occasional changes.
The Admin API is more appropriate when an operation must be:
- automated;
- repeated regularly;
- integrated into another application;
- applied consistently across multiple servers;
- exposed through a custom interface.
In many environments, Admin Console and the Admin API are used side by side.
Where Is the API Documentation?
Claris provides an online introduction in the FileMaker Admin API Guide.
The detailed reference for the endpoints supported by a specific server is also installed with FileMaker Server. It can normally be opened at:
https://your-server-address/fmi/admin/apidoc
When accessed directly from the primary server, it is available at:
https://localhost/fmi/admin/apidoc
Claris explains the different ways to access this local documentation in its Admin API Reference information.
Conclusion
The FileMaker Server Admin API is the programmatic counterpart to many of the administrative capabilities found in FileMaker Server Admin Console.
It does not provide access to the business data contained in FileMaker files. Instead, it enables applications and scripts to administer the server itself: its hosted databases, connected users, schedules, services, configuration, and other operational components.
For developers, IT departments, and FileMaker hosting providers, it provides the foundation for creating more reliable, scalable, and automated FileMaker Server management tools.
