filemaker_admin_api 0.1.0

A typed Dart client for the Claris FileMaker Admin API v2. Manage databases, clients, schedules and server config over REST.

filemaker_admin_api

A typed Dart client for the Claris FileMaker Admin API v2. Manage databases, clients, schedules and server configuration over REST, from anywhere Dart runs.

Not affiliated with or endorsed by Claris International Inc. "FileMaker" and "Claris" are trademarks of Claris International Inc.

The FileMaker API family

This is one of three companion packages:

Package	Purpose
filemaker_data_api	Read/write record data via layouts
filemaker_odata_api	Read/write record data via OData v4
filemaker_admin_api (this package)	Administer the server: databases, clients, schedules, config

The Admin API is for server administration, not data access. Authentication uses the server's root administrator account.

Requirements

• FileMaker Server 18 or later (Admin API v2).
• The root administrator account name and password.

Install

dependencies:
  filemaker_admin_api: ^0.1.0

Usage

import 'package:filemaker_admin_api/filemaker_admin_api.dart';

final admin = AdminClient(
  host: 'https://fms.example.com',
  username: 'admin',
  password: 'secret',
);

for (final db in await admin.listDatabases()) {
  print('${db['id']}: ${db['filename']} (${db['status']})');
}

await admin.logout();
admin.close();

Safety: server-changing operations are guarded

Read operations (listDatabases, listClients, listSchedules, serverGeneralConfig, serverSecurityConfig) run freely. Operations that change server state require an explicit confirm: true, so you cannot accidentally close a database or disconnect a user:

await admin.closeDatabase(1, confirm: true);
await admin.disconnectClient(5, confirm: true);
await admin.runSchedule(2, confirm: true);

Calling these without confirm: true throws a StateError.

Error handling

Exception	When
AdminAuthException	Bad admin credentials or rejected token
AdminTransportException	Host unreachable or non-JSON response
AdminException	Any other Admin API error

Scope

This release covers the stable core of Admin API v2 available since FileMaker Server 18: database, client, schedule and server-config operations. Endpoints added in later server versions (standby server, certificate management additions, newer external-auth providers) are not yet wrapped.

License

MIT