The FileMaker Admin API

Beginner

Automate FileMaker Server management tasks using the REST-based Admin API.

What you'll learn

  • What the Admin API can and cannot do
  • Authenticating to the Admin API
  • Key Admin API endpoints for common automation tasks
  • Security considerations for Admin API access

The FileMaker Admin API is a REST interface for managing FileMaker Server programmatically -- without logging into the Admin Console. It enables automation of: file management (open, close, pause), schedule management, client disconnection, certificate management, and server statistics. It is the foundation of tools like FM Dojo that interact with your server programmatically.

1/4
1

What the Admin API does

The Admin API manages the server, not data. It can: list, open, close, and pause hosted databases; disconnect clients; run or pause scheduled scripts; retrieve server statistics and logs; manage SSL certificates; and restart FileMaker Server processes. It does NOT read or write FileMaker record data -- that is the Data API.

HTTP
// Admin API base URL:
https://your-fm-server.example.com/fmadmin/api/v2

// Key endpoints:
GET  /databases            -- list hosted files
PATCH /databases/{id}      -- open, close, pause a file
GET  /clients              -- list connected clients
DELETE /clients/{id}       -- disconnect a client
GET  /schedules            -- list scheduled scripts
PATCH /schedules/{id}      -- run or pause a schedule
GET  /server/status        -- server statistics
Authentication Methods Available for WebDirectScheduled Scripts on FileMaker Server

Sign in to track your progress and pick up where you left off.

Sign in to FM Dojo