FileMaker Data API reference information

The FileMaker Data API reference provides detailed information about all of the calls supported by the Data API.

Note  To view the reference information, check that FileMaker Data API access has been enabled in Admin Console. See the Product Documentation Center.

• To view the reference files on a FileMaker Cloud host, open a browser and enter the URL

  https://host/fmi/data/apidoc/

  where host is the host name of the FileMaker Cloud host.

• To view the reference files on a FileMaker Server primary machine, open a browser and enter the URL

  https://localhost/fmi/data/apidoc/

• To view the reference information on a FileMaker Server remote machine, open a browser and enter the URL

  https://host/fmi/data/apidoc/

  where host is the IP address or host name of the primary machine running FileMaker Server.

• For FileMaker Server installed on a Windows server: The reference files are in the folder

  [drive]:\Program Files\FileMaker\FileMaker Server\Documentation\Data 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\Data API Documentation

• For FileMaker Server installed on a macOS server: The reference files are in the folder

  /Library/FileMaker Server/Documentation/Data API Documentation

• For FileMaker Server installed on a remote Linux machine, the reference files are in the folder

  /opt/FileMaker/FileMaker Server/Documentation/Data API Documentation

Notes 

• The reference files show variables in the URLs by using a keyword preceded by a colon (:). For example: :database.

• This guide shows variables in the URLs by using an italic font. For example: database-name