Admin API Reference information

FileMaker Admin API Reference is installed with FileMaker Server and FileMaker Cloud. The reference provides detailed information about all of the calls supported by FileMaker Admin API.

To view the reference for FileMaker Cloud, enter the following URL in a browser window:

https://host/fmi/admin/apidoc/

where host is the host name or IP address of the virtual server running FileMaker Cloud.

To access the reference for FileMakerServer:

  • To view the reference in a browser window on the primary machine, enter the following URL:

    https://localhost/fmi/admin/apidoc/

  • To view the reference in a browser window on a remote machine, enter the following URL:

    https://host/fmi/admin/apidoc/

  • On a Windows server, the reference is in the following folder:

    [drive]:\Program Files\FileMaker\FileMaker Server\Documentation\Admin API Documentation

    where [drive] is the drive on which your FileMaker Server deployment resides.

    If you install using a non-default location on Windows, your installation location replaces the beginning of the default installation path:

    [drive]:installation_location\FileMaker\FileMaker Server\Documentation\Admin API Documentation

  • On a macOS server, the reference files are in the following folder:

    /Library/FileMaker Server/Documentation/Admin API Documentation

  • On a Linux server installed on a remote or primary machine, the reference files are in the following folder:

    /opt/FileMaker/FileMaker Server/Documentation/Admin API Documentation

Notes 

  • The FileMaker Admin API Reference doesn't include information about the following API calls: uploading and updating custom apps, inviting users to a team, and adding users to a group.

  • If you use the URL examples in the Admin API Reference, and you open the reference file from your local drive, all examples start with file:///. To use the URLs, replace file:/// with https://YourHostName/fmi/admin/api/v2.