logo
API docs by Redocly

Claris FileMaker Server Admin API Reference

Download OpenAPI specification:Download

Authentication

Request Access Token

Request an access token from the host using the root administrator account name and password or a PKI token.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Invalidate Access Token

Invalidate the specified JSON Web Token.

path Parameters
access_token
required
string

The JSON Web Token.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Database Server

Get Server Metadata

Get the name, ID, IP address, and version of the Database Server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Admin Console Account

Change the Admin Console account user name and password.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Admin Console account parameters

newUsername
required
string

New user name for Admin Console.

newPassword
required
string

New password for Admin Console.

currentUsername
required
string

Current user name for Admin Console.

currentPassword
required
string

Current password for Admin Console.

Responses

Request samples

Content type
application/json
{
  • "newUsername": "a",
  • "newPassword": "a",
  • "currentUsername": "admin",
  • "currentPassword": "admin"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Server Name

Update the database server name.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Update server name parameter

ServerName
required
string

The server name to change to.

Responses

Request samples

Content type
application/json
{
  • "ServerName": "localhost"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server Status

Get the Database Server status.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Server Status

Run or stop the Database Server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server Status Parameter

status
required
string (ServerStatus)
Enum: "RUNNING" "STOPPED"

If used with GET, specifies whether FileMaker Database Server is running. If used with PATCH, allows you to start or stop FileMaker Database Server.

messageText
string [ 0 .. 200 ] characters

The message to send to the FileMaker client when stopping the Database Server.

graceTime
integer [ 0 .. 3600 ]
Default: 90

The length of seconds to delay before stopping the Database Server.

Responses

Request samples

Content type
application/json
{
  • "status": "RUNNING"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Administrator Contact Information

Get administrator contact information.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Administrator Contact Information

Update administrator contact information.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Administrator contact information parameter

contactName
required
string [ 0 .. 100 ] characters

Administrator contact name.

contactEmail
required
string [ 0 .. 100 ] characters

Administrator contact email address.

contactPhone
required
string [ 0 .. 100 ] characters

Administrator contact phone number.

Responses

Request samples

Content type
application/json
{
  • "contactName": "myname",
  • "contactEmail": "mytestemail@mytestemail.com",
  • "contactPhone": "1234567890"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Administrator Roles Server Setting

Get the server administrator roles setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": [
    ],
  • "messages": [
    ]
}

Create Administrator Role Server Setting

Create administrator role server setting

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server Create Admin Role Setting Parameter

name
required
string

Name of the admininstrator role

password
required
string

Password of the administrator role

homeFolder
required
string

Home folder of the admininstrator role

db_pri
boolean

Whether or not admininstrator role has database privilege

sched_pri
boolean

Whether or not administrator role has schedules privilege

sched_backup_pri
boolean

Whether or not admininstrator role has backup schedules privilege

sched_verify_pri
boolean

Whether or not admininstrator role has verify schedules privilege

sched_script_pri
boolean

Whether or not admininstrator role has script schedules privilege

log_pri
boolean

Whether or not admininstrator role has log privilege

xauthGroup
string

External Group for the admininstrator role

Responses

Request samples

Content type
application/json
{
  • "name": "Role 1",
  • "password": "my$ecret",
  • "homeFolder": "filemac:/FileMaker Server/Data/Databases"
}

Response samples

Content type
application/json
{
  • "response": [
    ],
  • "messages": [
    ]
}

Update Administrator Role Server Setting

Update administrator role server setting

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server Update Admin Role Setting Parameter

id
required
number

ID of the admininstrator role

name
string

Name of the administrator role

password
string

Password of the administrator role

homeFolder
string

Home folder of the admininstrator role

db_pri
boolean

Whether or not admininstrator role has database privilege

sched_pri
boolean

Whether or not administrator role has schedules privilege

sched_backup_pri
boolean

Whether or not admininstrator role has backup schedules privilege

sched_verify_pri
boolean

Whether or not admininstrator role has verify schedules privilege

sched_script_pri
boolean

Whether or not admininstrator role has script schedules privilege

log_pri
boolean

Whether or not admininstrator role has log privilege

xauthGroup
string

External Group for the admininstrator role

Responses

Request samples

Content type
application/json
{
  • "id": 123456789,
  • "name": "Role 1",
  • "password": "My$ecret",
  • "homeFolder": "filemac:/FileMaker Server/Data/Databases"
}

Response samples

Content type
application/json
{
  • "response": [
    ],
  • "messages": [
    ]
}

Delete Administrator Roles Server Setting

Delete administrator roles server setting

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server Delete Admin Role Setting Parameter

names
Array of strings

Names of administrator roles to delete

ids
Array of numbers

IDs of administrator roles to delete

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "response": [
    ],
  • "messages": [
    ]
}

Get Server Security Setting

Get the server security setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Server Security Setting

Update the server security setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server Security Setting Parameter

requireSecureDB
required
boolean

If set to true, only databases with password-protected accounts that have the Full Access privilege set can be opened for hosting. Applies only to the default and additional folders.

Responses

Request samples

Content type
application/json
{
  • "requireSecureDB": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server General Settings

Get the server general settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Server General Settings

Update the server general settings. All parameters are optional, but at least one parameter is required.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server General Settings Parameter

cacheSize
integer >= 64

Cache memory (in megabytes) allocated by the server. The maximum setting is not enforced, but allocating more memory than what the system can manage will impact server performance.

maxFiles
integer [ 1 .. 256 ]

Maximum number of databases that can be hosted.

maxProConnections
integer [ 0 .. 2000 ]

Maximum number of FileMaker Pro client connections.

maxPSOS
integer [ 0 .. 500 ]

Maximum number of script sessions that can run on the server simultaneously.

openDatabasesOnStart
boolean

Automatically open databases that are in the database folders when the database server starts. If openDatabasesOnStart is set to false, onlyOpenLastOpenedDatabases is also set to false.

onlyOpenLastOpenedDatabases
boolean

Only open databases that were open when the database server was last shut down. If openDatabasesOnStart is false, onlyOpenLastOpenedDatabases can't be set to true.

useSchedules
boolean

Allow enabled schedules to run.

autostartDBS
boolean

Whether the Database Server should start automatically. If autostartDBS is set to false, autostartWPE is also set to false.

autostartWPE
boolean

Whether the Web Publishing Engine should start automatically. If autostartDBS is set to false, autostartWPE can't be set to true.

Responses

Request samples

Content type
application/json
{
  • "cacheSize": 200,
  • "maxFiles": 50,
  • "maxProConnections": 100,
  • "maxPSOS": 20,
  • "openDatabasesOnStart": true,
  • "onlyOpenLastOpenedDatabases": false,
  • "useSchedules": true,
  • "autostartDBS": true,
  • "autostartWPE": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Server Progressive Backups Setting

Update the server progressive backups setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server progressive backups setting parameter

incrementalBackupEnabled
required
boolean

If set to true, progressive backups are enabled. If not, they are disabled.

Responses

Request samples

Content type
application/json
{
  • "incrementalBackupEnabled": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Cancel currently running backup

Cancel currently running backup

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable Server Additional Database Folder Settings

Enable or disable the additional database folder settings for the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server additional database folder settings parameter

UseOtherDatabaseRoot
boolean

If set to true, the first additional database folder is enabled. If not, it is disabled. To set UseOtherDatabaseRoot to true, make sure DatabaseRootPath is specified in the same request.

DatabaseRootPath
string

First additional database folder path. To change path, make sure UseOtherDatabaseRoot has been enabled.

UseDatabaseRoot1_RC
boolean

If set to true, the first additional remote container folder is enabled. If not, it is disabled. To set UseDatabaseRoot1_RC to true, make sure DatabaseRootPath1_RC is specified in the same request and UseOtherDatabaseRoot has been enabled.

DatabaseRootPath1_RC
string

First additional remote container folder path. To change path, make sure UseOtherDatabaseRoot and UseDatabaseRoot1_RC have been enabled.

backupDatabaseRoot1_RC
boolean

If set to true, backup for the first additional remote container folder is enabled. If not, it is disabled. To set backupDatabaseRoot1_RC to true, make sure UseOtherDatabaseRoot and UseDatabaseRoot1_RC have been enabled.

UseOtherDatabaseRoot3
boolean

If set to true, the second additional database folder is enabled. If not, it is disabled. To set UseOtherDatabaseRoot3 to true, make sure DatabaseRootPath3 is specified in the same request.

DatabaseRootPath3
string

Second additional database folder path. To change path, make sure UseOtherDatabaseRoot3 has been enabled.

UseDatabaseRoot3_RC
boolean

If set to true, the second additional remote container folder is enabled. If not, it is disabled. To set UseDatabaseRoot3_RC to true, make sure DatabaseRootPath3_RC is specified in the same request and UseOtherDatabaseRoot3 has been enabled.

DatabaseRootPath3_RC
string

Second additional remote container folder path. To change path, make sure UseOtherDatabaseRoot3 and UseDatabaseRoot3_RC have been enabled.

backupDatabaseRoot3_RC
boolean

If set to true, backup for the second additional remote container folder is enabled. If not, it is disabled. To set backupDatabaseRoot3_RC to true, make sure UseOtherDatabaseRoot3 and UseDatabaseRoot3_RC have been enabled.

Responses

Request samples

Content type
application/json
{
  • "UseOtherDatabaseRoot": true,
  • "DatabaseRootPath": "filemac:/Mojave/Users/FMS/ServerFolder/",
  • "UseDatabaseRoot1_RC": true,
  • "DatabaseRootPath1_RC": "filemac:/Mojave/Users/FMS/ServerRC/",
  • "backupDatabaseRoot1_RC": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable Server Discovery Setting

Enable or disable server discovery by FileMaker Pro and FileMaker Go clients.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server discovery setting parameter

serverDiscovery
required
boolean

If set to true, server discovery is enabled, and FileMaker Pro and FileMaker Go can discover the server. If set to false, FileMaker Pro and FileMaker Go will not discover the server.

Responses

Request samples

Content type
application/json
{
  • "serverDiscovery": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Authenticated Stream Setting

Get streaming URL cookie check setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Set Authenticated Stream Setting

Set streaming URL cookie check setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Authenticated stream setting parameter

authenticatedStream
required
integer
Enum: 1 2

Use cookie: 1; No cookie check: 2

Responses

Request samples

Content type
application/json
{
  • "authenticatedStream": 1
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Allow certificate with unknown revocation status

Allow certificate with unknown revocation status.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "message": [
    ]
}

Allow certificate with unknown revocation status

Allow certificate with unknown revocation status.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Allow certificate with unknown revocation status setting parameter

allowUnknownSSLCertificateRevocation
required
boolean

Allow certificate with unknown revocation status: true; Not allowed: false

Responses

Request samples

Content type
application/json
{
  • "allowUnknownSSLCertificateRevocation": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server Parallel Backup Setting

Get the server parallel backup setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "message": [
    ]
}

Update Server Parallel Backup Setting

Update the server parallel backup setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Update the server parallel backup setting.

parallelBackupEnabled
required
boolean

Server parallel backup setting.

Responses

Request samples

Content type
application/json
{
  • "parallelBackupEnabled": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Restrict Access

Restrict FileMaker Server Admin Console and Admin API access either to the current machine or to specific IP addresses.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "message": [
    ]
}

Update Restrict Access

Restrict FileMaker Server Admin Console and Admin API access either to the current machine or to specific IP addresses.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Update the server restrict IP Address setting and/or allowed IP list.

restrictIPEnabled
required
boolean

To enable IP address restriction to Admin Console.

restrictIPList
required
string or null

IP address of the computer allowed access to Admin Console. Use commas to separate multiple IP addresses.

Responses

Request samples

Content type
application/json
{
  • "restrictIPEnabled": true,
  • "restrictIPList": "127.0.0.1"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get FileMaker Admin API Public Keys Server Setting

Get the FileMaker Admin API public keys server setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "message": [
    ]
}

Add FileMaker Admin API Public Key Server Setting

Add FileMaker Admin API public key server setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Add FileMaker Admin API public keys server setting.

name
required
string

Name of the public key.

publicKey
required
string

Public key.

Responses

Request samples

Content type
application/json
{
  • "name": "My Public Key",
  • "publicKey": "-----BEGIN PUBLIC KEY-----MIIBCgKCAQEA+xGZ/wcz9ugFpP07Nspo6U17l0YhFiFpxxU4pTk3Lifz9R3zsIsuERwta7+fWIfxOo208ett/jhskiVodSEt3QBGh4XBipyWopKwZ93HHaDVZAALi/2A+xTBtWdEo7XGUujKDvC2/aZKukfjpOiUI8AhLAfjmlcD/UZ1QPh0mHsglRNCmpCwmwSXA9VNmhz+PiB+Dml4WWnKW/VHo2ujTXxq7+efMU4H2fny3Se3KYOsFPFGZ1TNQSYlFuShWrHPtiLmUdPoP6CV2mML1tk+l7DIIqXrQhLUKDACeM5roMx0kLhUWB8P+0uj1CNlNN4JRZlC7xFfqiMbFRU9Z4N6YwIDAQAB-----END PUBLIC KEY-----"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update FileMaker Admin API Public Keys Server Setting

Update FileMaker Admin API public key server setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Update FileMaker AdminAPI public key server setting.

name
required
string

Name of the public key.

publicKey
required
string

Public key.

Responses

Request samples

Content type
application/json
{
  • "name": "My Public Key",
  • "publicKey": "-----BEGIN PUBLIC KEY-----MIIBCgKCAQEA+xGZ/wcz9ugFpP07Nspo6U17l0YhFiFpxxU4pTk3Lifz9R3zsIsuERwta7+fWIfxOo208ett/jhskiVodSEt3QBGh4XBipyWopKwZ93HHaDVZAALi/2A+xTBtWdEo7XGUujKDvC2/aZKukfjpOiUI8AhLAfjmlcD/UZ1QPh0mHsglRNCmpCwmwSXA9VNmhz+PiB+Dml4WWnKW/VHo2ujTXxq7+efMU4H2fny3Se3KYOsFPFGZ1TNQSYlFuShWrHPtiLmUdPoP6CV2mML1tk+l7DIIqXrQhLUKDACeM5roMx0kLhUWB8P+0uj1CNlNN4JRZlC7xFfqiMbFRU9Z4N6YwIDAQAB-----END PUBLIC KEY-----"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Delete FileMaker Admin API Public Keys

Delete FileMaker Admin API public key(s) by name(s)

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

List of names of public keys to delete

names
required
Array of strings

List of names of public keys to delete

Responses

Request samples

Content type
application/json
{
  • "names": [
    ]
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Persistent Cache Setting

Get persistent cache setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Set Persistent Cache Setting

Set persistent cache setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Persistent cache setting parameter

persistentCache
required
boolean

Whether persistent cache is enabled.

persistentCacheSync
required
boolean

Whether persistent cache sync is enabled.

databaseServerAutoRestart
required
boolean

Whether database server auto restart is enabled.

Responses

Request samples

Content type
application/json
{
  • "persistentCache": false,
  • "persistentCacheSync": false,
  • "databaseServerAutoRestart": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Block New Users Setting

Get block new users setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Set Block New Users Setting

Set block new users setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Block New Users setting parameter

blockNewUsers
required
boolean

Whether Block New Users is enabled.

Responses

Request samples

Content type
application/json
{
  • "blockNewUsers": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server Current Folder Settings

Get the current folder settings for the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server Additional Database Folder Paths

Get the additional database folder paths for the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server Additional Remote Container Folder Paths

Get the additional remote container folder paths for the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server Backup Folder Path

Get the backup folder path for the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Server Default Backup Folder Path

Update the default backup folder path for the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server default backup folder path parameter

backupPath
required
string

Server default backup folder path.

Responses

Request samples

Content type
application/json
{
  • "backupPath": "filemac:/Mojave/Library/FileMaker Server/Data/Backups/"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Server Progressive Backup Folder Path

Get the progressive backup folder path for the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Server Progressive Backup Folder Path

Update the server progressive backup folder path.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server default progressive backup folder path parameter

progressiveBackupPath
required
string

Server progressive backup folder path.

Responses

Request samples

Content type
application/json
{
  • "progressiveBackupPath": "filemac:/Mojave/Library/FileMaker Server/Data/Progressive/"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Databases

List Databases

List all hosted databases.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Perform Database Operations for All Databases

Open, close, pause, or resume all databases.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Database action parameter

status
required
string
Enum: "OPENED" "PAUSED" "RESUMED" "CLOSED"

Status of the database.

force
boolean

Forces databases to be closed and disconnects connected clients. Overrides the graceTime option. Allowed only if status = CLOSED.

Responses

Request samples

Content type
application/json
{
  • "status": "PAUSED"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Perform Database Operations for a Database

Open, close, pause, or resume the specified database.

path Parameters
db_id
required
integer >= 1

Database ID

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Database action parameter

status
required
string
Enum: "OPENED" "PAUSED" "RESUMED" "CLOSED"

Status of the database.

key
string

The password required to open an encrypted database. Required and allowed only if status = OPENED. Note: FileMaker Admin API does not validate the encryption key. You receive an error code of 0 even if you enter an invalid key.

saveKey
boolean

Allow the host to save the encryption password. Allowed only if status = OPENED.

messageText
string [ 0 .. 200 ] characters

The text message to send to the client being disconnected. Required and allowed only if status = CLOSED.

force
boolean

Forces databases to be closed and disconnects connected clients. Overrides the graceTime option. Allowed only if status = CLOSED.

Responses

Request samples

Content type
application/json
{
  • "status": "OPENED",
  • "key": "My$ecret"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Remove a Database

Remove a database specified by the database ID. You must close the database before you remove it.

path Parameters
db_id
required
integer >= 1

Database ID

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Download Database

Download a database

path Parameters
db_id
required
integer >= 1

Database ID

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Upload Database

Upload a database

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Request Body schema: multipart/form-data
uploadFile
required
string <binary>

Database upload file data. Example: File Binary.

uploadDest
required
string

Database upload file destination path on FileMaker Server. Example: "Databases/file_to_upload.fmp12".

EARKey
string

Base64-encoded encryption password for the encrypted database to be uploaded. FileMaker Server will attempt to open the file if both the "EARKey" parameter is defined and the "saveEARKey" parameter is set to "true". Example: "RmlsZU1ha2Vy".

saveEARKey
boolean

Whether to save the encryption password for the encrypted database to be uploaded. FileMaker Server will attempt to open the file if both the "EARKey" parameter is defined and the "saveEARKey" parameter is set to "true". Example: "false".

openOnServer
boolean

Whether to open the database to be uploaded on FileMaker Server. Default is false. Example: "false".

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Client Management

List Clients

List the connected clients.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Send Message to Client

Send a message to a FileMaker client.

  • You cannot send a message to a client that is connected via FileMaker Data API. You receive an error code of 0 even if the client is connected via FileMaker Data API.
path Parameters
client_id
required
integer >= 1

ID of the client to send a message to.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json
messageText
required
string [ 1 .. 200 ] characters ^(?!\s*$).+

The text message to send to the client. This parameter cannot be an empty string or a string of whitespace characters.

Responses

Request samples

Content type
application/json
{
  • "messageText": "Hello John"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Disconnect Client

Disconnect a FileMaker client.

  • The following is an example of using the query parameters to disconnect a client: https://{YourHostName}/fmi/admin/api/v2/clients/{client_id}?messageText=yourMessage&graceTime=30
path Parameters
client_id
required
integer >= 1

ID of the client to disconnect.

query Parameters
messageText
string [ 0 .. 200 ] characters

The text message to send to the client that is being disconnected.

graceTime
integer [ 0 .. 3600 ]
Default: 90

The number of seconds to wait before disconnecting the client.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Schedules

List Schedules

List all schedules.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Duplicate Schedule

Duplicate a schedule specified by the schedule ID.

  • The following is an example of using the query parameters to duplicate a schedule: https://{YourHostName}/fmi/admin/api/v2/schedules?source=2
query Parameters
source
required
integer >= 2

The schedule ID for the schedule to duplicate. Schedule ID 1 is reserved by FileMaker Server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Create Backup Schedule

Create a Backup schedule.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Create Backup Schedule Parameter

name
required
string [ 1 .. 100 ] characters ^(?!\s*$).+

Schedule name. This parameter cannot be an empty string or a string of whitespace characters.

required
object

Parameters for the backup schedule.

sendEmail
Array of strings

Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.

enabled
boolean

To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.

object

If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.

object

If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.

object

If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

Responses

Request samples

Content type
application/json
{
  • "name": "BackupSchedule",
  • "backupType": {
    },
  • "enabled": true,
  • "everyndaysType": {
    },
  • "sendEmail": [
    ]
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Create FileMaker Script Schedule

Create a FileMaker Script schedule.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

The parameter for creating a FileMaker Script Schedule.

name
required
string [ 1 .. 100 ] characters ^(?!\s*$).+

Schedule name. This parameter cannot be an empty string or a string of whitespace characters.

required
object

Parameters for the FileMaker script schedule.

sendEmail
Array of strings

Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.

enabled
boolean

To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.

object

If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.

object

If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.

object

If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

Responses

Request samples

Content type
application/json
{
  • "name": "FileMakerScriptSchedule",
  • "filemakerScriptType": {
    },
  • "weeklyType": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Create Message Schedule

Create a message schedule.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Create Message Schedule Parameter

name
required
string [ 1 .. 100 ] characters ^(?!\s*$).+

Schedule name. This parameter cannot be an empty string or a string of whitespace characters.

required
object

Parameters for the message schedule.

sendEmail
Array of strings

Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.

enabled
boolean

To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.

object

If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.

object

If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.

object

If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

Responses

Request samples

Content type
application/json
{
  • "name": "MessageSchedule",
  • "messageType": {
    },
  • "onceType": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Create Script Sequence Schedule

Create a Script Sequence schedule.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Create Script Sequence Schedule Parameter

name
required
string [ 1 .. 100 ] characters ^(?!\s*$).+

Schedule name. This parameter cannot be an empty string or a string of whitespace characters.

required
object

Parameters for the script sequence schedule.

sendEmail
Array of strings

Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.

enabled
boolean

To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.

object

If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.

object

If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.

object

If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

Responses

Request samples

Content type
application/json
{
  • "name": "ScriptSequenceSchedule",
  • "scriptSequenceType": {
    },
  • "everyndaysType": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Create System Script Schedule

Create a System Script schedule.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Create System Script Schedule Parameter

name
required
string [ 1 .. 100 ] characters ^(?!\s*$).+

Schedule name. This parameter cannot be an empty string or a string of whitespace characters.

required
object

Parameters for the system script schedule.

sendEmail
Array of strings

Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.

enabled
boolean

To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.

object

If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.

object

If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.

object

If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

Responses

Request samples

Content type
application/json
{
  • "name": "SystemScriptSchedule",
  • "systemScriptType": {
    },
  • "weeklyType": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Create Verify Schedule

Create a Verify schedule.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Create Verify Schedule Parameter

name
required
string [ 1 .. 100 ] characters ^(?!\s*$).+

Schedule name. This parameter cannot be an empty string or a string of whitespace characters.

required
object

Parameters for the verify schedule.

sendEmail
Array of strings

Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.

enabled
boolean

To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.

object

If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.

object

If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.

object

If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

Responses

Request samples

Content type
application/json
{
  • "name": "VerifySchedule",
  • "verifyType": {
    },
  • "onceType": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Schedule

Get a schedule specified by the schedule ID.

path Parameters
schedule_id
required
integer >= 2

ID of the schedule. Schedule ID 1 is reserved by FileMaker Server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Edit/Run Schedule

Edit or run a schedule specified by schedule_id. Each parameter is optional, but at least one parameter is required.

  • To run a schedule, set the 'status' parameter to 'RUNNING'.
  • Use this call to run a schedule. Use the Get Schedule API call to verify the results.
  • You can not change schedule type in edit schedule api.
path Parameters
schedule_id
required
integer >= 2

ID of the schedule. Schedule ID 1 is reserved by FileMaker Server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Edit/Run Schedule Parameter

name
string [ 1 .. 100 ] characters ^(?!\s*$).+

Schedule name. This parameter cannot be an empty string or a string of whitespace characters.

status
string
Enum: "IDLE" "RUNNING"

Whether to run the schedule.

object

If used with POST or PATCH, allows you to create or edit a schedule to run on the specified date and time.

object

If used with POST or PATCH, allows you to create or edit a schedule to run weekly on one or more days.

object

If used with POST or PATCH, allows you to create or edit a schedule that has a specific interval in days, such as every 2, 3, or 4 days.

sendEmail
Array of strings

Email addresses to send notifications to. An empty array disables sending email. Note: SMTP configuration is required for sending email.

enabled
boolean

To enable a schedule to run, or to find out whether the schedule is enabled to run. If you create a schedule without specifying this parameter, the default value 'false' is used.

object

Parameters for the backup schedule.

object

Parameters for the FileMaker script schedule.

object

Parameters for the message schedule.

object

Parameters for the script sequence schedule.

object

Parameters for the system script schedule.

object

Parameters for the verify schedule.

Responses

Request samples

Content type
application/json
{
  • "name": "UpdatedSchedule",
  • "systemScriptType": {
    },
  • "weeklyType": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Delete Schedule

Delete a schedule specified by the schedule ID.

path Parameters
schedule_id
required
integer >= 2

ID of the schedule. Schedule ID 1 is reserved by FileMaker Server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

PHP

PHP Settings

Get the PHP settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update PHP Settings

Update the PHP settings. Parameters are optional, but at least one parameter is required.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

PHP Configuration Parameter

characterEncoding
string
Enum: "UTF-8" "ISO-8859-1"

The default character encoding for PHP.

dataPreValidation
boolean

Whether the record data should be validated before committing changes to the Database Server.

enabled
boolean

If used with GET, specifies whether Custom Web Publishing with PHP is enabled or disabled. If used with PATCH, allows you to enable or disable Custom Web Publishing with PHP.

errorMessageLanguage
string
Enum: "en" "it" "de" "fr" "ja"

The language used for error messages for PHP.

useFileMakerPhp
boolean

Whether to use the FileMaker version of the PHP engine rather than your own version of PHP.

Responses

Request samples

Content type
application/json
{
  • "characterEncoding": "UTF-8",
  • "dataPreValidation": true,
  • "enabled": true,
  • "errorMessageLanguage": "en",
  • "useFileMakerPhp": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

XML

XML Settings

Get the XML settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update XML Settings

Update the XML settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

XML Configuration Parameter

enabled
required
boolean

If used with GET, specifies whether XML is enabled or disabled. If used with PATCH, allows you to enable or disable XML.

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

ODBC/JDBC

ODBC/JDBC Settings

Get the ODBC/JDBC settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update ODBC/JDBC Settings

Update the ODBC and JDBC settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

ODBC/JDBC Configuration Parameter

enabled
required
boolean

If used with GET, specifies whether ODBC/JDBC is enabled or disabled. If used with PATCH, allows you to enable or disable ODBC/JDBC.

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

FileMaker Data API

FileMaker Data API Usage

Get the FileMaker Data API usage.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

FileMaker Data API Settings

Get the FileMaker Data API settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update FileMaker Data API Settings

Update the FileMaker Data API settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

FileMaker Data API Configuration Parameter

enabled
required
boolean

If used with GET, specifies whether FileMaker Data API is enabled or disabled. If used with PATCH, allows you to enable or disable FileMaker Data API.

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Web Publishing Engine

FileMaker WebDirect Settings

Get the FileMaker WebDirect settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update FileMaker WebDirect Settings

Update the FileMaker WebDirect settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

FileMaker WebDirect Configuration Parameter

enabled
required
boolean

If used with GET, specifies whether FileMaker WebDirect is enabled or disabled. If used with PATCH, allows you to enable or disable FileMaker WebDirect.

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

WPE Settings for All Machines

Get the Web Publishing Engine settings for all machines.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": [
    ],
  • "messages": [
    ]
}

WPE Settings for a Single Machine

Get the Web Publishing Engine settings for a single machine.

path Parameters
machine_id
required
integer >= 1

ID of machine

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update WPE Settings

Update the Web Publishing Engine settings.

path Parameters
machine_id
required
integer >= 1

ID of machine

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

WPE Configuration Parameter

enabled
required
boolean

If used with GET, specifies whether Web Publishing Engine is enabled or disabled. If used with PATCH, allows you to enable or disable Web Publishing Engine.

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Nginx Load Balancer URL Setting

Get the Nginx load balancer URL setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Nginx Load Balancer URL Setting

Update the Nginx load balancer URL setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Nginx Load Balancer URL Parameter

NginxLoadBalancerUrl
required
string

Nginx load balancer URL.

Responses

Request samples

Content type
application/json
{
  • "NginxLoadBalancerUrl": "www.example.com"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Max Number of CWP Connections Setting

Get maximum number of Custom Web Publishing connections setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Max Number of CWP Connections Setting

Update maximum number of Custom Web Publishing connections setting.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Max Number of CWP Connections Setting Parameter

maxCwpSessions
required
integer [ 1 .. 2000 ]

Maximum number of Custom Web Publishing connections.

Responses

Request samples

Content type
application/json
{
  • "maxCwpSessions": 200
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

License

Get License Information

Get the license information of the server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Import License

Import new license to the database server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

License parameters

licensecert
required
string

Base 64 encoded value of the whole contents from LicenseCert.fmcert file.

Responses

Request samples

Content type
application/json
{
  • "licensecert": "Base 64 encoded value of the whole contents from LicenseCert.fmcert file."
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Sync up License

Sync with license server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

Notifications

Enable/Disable Email Notifications

Enable or disable email notifications.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

The enable or disable parameter for email notifications.

emailNotification
required
integer
Enum: 0 1

Disable: 0; Enable:1

Responses

Request samples

Content type
application/json
{
  • "emailNotification": 1
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Email Notification Settings

Get current email notification settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Email Notification Settings

Update current email notification settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Server email notification setting parameters

emailSenderAddress
string [ 0 .. 100 ] characters

Sender's email address

emailReplyAddress
string [ 0 .. 100 ] characters

Email reply-to address

emailRecipients
required
string [ 0 .. 100 ] characters

Recipient's email address. Use commas to separate multiple email addresses.

smtpServerAddress
required
string [ 0 .. 255 ] characters

SMTP server address

smtpServerPort
required
integer [ 1 .. 65535 ]

SMTP server port:

  • SSL: 465
  • TLS: 587
  • None: 25
smtpUsername
string

SMTP username. Required when smtpAuthType is not 0.

smtpPassword
string

SMTP password. Required when smtpAuthType is not 0.

smtpAuthType
required
integer
Enum: 0 3 5

SMTP authentication type:

  • 0: None
  • 3: Plain Text
  • 5: CRAM-MD5
smtpSecurity
integer
Enum: 0 1 2 3 4

SMTP security type:

  • 0: Do not verify the server certificate
  • 1: SSL and Do not verify the server certificate
  • 2: TLS and Do not verify the server certificate
  • 3: SSL
  • 4: TLS
notifyLevel
integer
Enum: 1 2

Notification level:

  • 1: Errors only
  • 2: Errors and warnings

Responses

Request samples

Content type
application/json
{
  • "emailSenderAddress": "sender@test.com",
  • "emailReplyAddress": "noreply@test.com",
  • "emailRecipients": "test123@claris.com,test456@claris.com, test678@claris.com",
  • "smtpServerAddress": "17.87.66.123",
  • "smtpServerPort": 465,
  • "smtpUsername": "tester",
  • "smtpPassword": "tester",
  • "smtpAuthType": 3,
  • "smtpSecurity": 3,
  • "notifyLevel": 1
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

External Authentication

Get External Account Group Name

Get the external account group name.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update External Account Group Name

Update the external account group name.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

External account group parameters

groupName
required
string

New external account group name.

Responses

Request samples

Content type
application/json
{
  • "groupName": "AdminAPI"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Amazon Identity Provider Information

Get the client ID and client secret for Amazon.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Amazon Identity Provider Information

Update the client ID and client secret for Amazon.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Amazon identity provider parameters

ClientID
required
string

Amazon client ID.

ClientSecret
required
string

Amazon client secret.

Responses

Request samples

Content type
application/json
{
  • "ClientID": "Provider Client ID",
  • "ClientSecret": "Provider Client Secret"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Google Identity Provider Information

Get the client ID and client secret for Google.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Google Identity Provider Information

Update the client ID and client secret for Google.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Google identity provider parameters

ClientID
required
string

Google client ID.

ClientSecret
required
string

Google client secret.

Responses

Request samples

Content type
application/json
{
  • "ClientID": "Provider Client ID",
  • "ClientSecret": "Provider Client Secret"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Microsoft Identity Provider Information

Get the ID, key, and directory ID for Microsoft Azure AD.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Microsoft Identity Provider Information

Update the ID, key, and directory ID for Microsoft Azure AD.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Microsoft Azure identity provider parameters

AzureID
required
string

Application ID for Microsoft Azure AD.

AzureKey
required
string

Key value for Microsoft Azure AD.

AzureDirectoryID
required
string

Directory ID for Microsoft Azure AD.

Responses

Request samples

Content type
application/json
{
  • "AzureID": "Azure ID",
  • "AzureKey": "Azure Key",
  • "AzureDirectoryID": "Azure Directory ID"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Custom OAuth Identity Provider Information

Get custom oauth settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Custom OAuth Identity Provider Information

Update Custom OAuth settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Custom OAuth identity provider parameters

OIDCEnabled
required
integer

1 is OIDC, 0 is OAuth2.0.

CustomIdPName
required
string

Custom IdP Name

ClientID
required
string

Custom OAuth client ID.

ClientSecret
required
string

Custom OAuth client secret.

AuthorizationCodeEndpoint
required
string

Authorization Code Endpoint.

AdditionalQueryParameters
string

Additional Query Parameters.

AuthorizationTokenEndpoint
required
string

Authorization Token Endpoint.

AuthorizationProfileEndpoint
string

Authorization Profile Endpoint. Required when OAuth2.0 is enabled.

CustomIdPIconEndpoint
string

Custom IdP Icon Endpoint.

CustomIdPUserAccountSchema
required
string

Custom IdP User Account Schema.

CustomIdPUserGroupSchema
string

Custom IdP User Group Schema.

Scope
required
string

Custom OAuth Scope.

Responses

Request samples

Content type
application/json
{
  • "OIDCEnabled": 0,
  • "CustomIdPName": "Custom IdP Name",
  • "ClientID": "Client ID",
  • "ClientSecret": "Client Secret",
  • "AuthorizationCodeEndpoint": "Authorization Code Endpoint",
  • "AdditionalQueryParameters": "Additional Query Parameters",
  • "AuthorizationTokenEndpoint": "Authorization Token Endpoint",
  • "AuthorizationProfileEndpoint": "Authorization Profile Endpoint",
  • "CustomIdPIconEndpoint": "Custom IdP Icon Endpoint",
  • "CustomIdPUserAccountSchema": "Custom IdP User Account Schema",
  • "CustomIdPUserGroupSchema": "Custom IdP User Group Schema",
  • "Scope": "Scope"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get AppleID Identity Provider Information

Get the service ID and client secret for AppleID.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update AppleID Identity Provider Information

Update the service ID and client secret for AppleID.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

AppleID identity provider parameters

ServiceID
required
string

AppleID service ID.

ClientSecret
required
string

AppleID client secret.

Responses

Request samples

Content type
application/json
{
  • "ServiceID": "Provider Service ID",
  • "ClientSecret": "Provider Client Secret"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable Admin Console Sign-In

Enable or disable Admin Console sign-in for external accounts. You must first configure the external account group.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Admin Console sign-in parameters

useExternalGroup
required
boolean

Allows you to enable or disable Admin Console sign-in.

Responses

Request samples

Content type
application/json
{
  • "useExternalGroup": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Database Sign-In Settings for External Server Accounts

Get database sign-in settings for external server accounts.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Database Sign-In Settings for External Server Accounts

Enable or disable database sign-in for external server accounts.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for database sign-in for external server accounts

EnableExtServerSignin
required
boolean

Allows you to enable or disable database sign-in for external server accounts.

Responses

Request samples

Content type
application/json
{
  • "EnableExtServerSignin": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Database Sign-In Settings for Amazon

Get database sign-in settings for Amazon.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Database Sign-In Settings for Amazon

Enable or disable database sign-in for Amazon. You must first configure the Amazon identity provider and enable database sign-in for external server accounts.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for database sign-in for Amazon

EnableAmazonSignin
required
boolean

Allows you to enable or disable database sign-in for Amazon.

Responses

Request samples

Content type
application/json
{
  • "EnableAmazonSignin": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Database Sign-In Settings for Google

Get database sign-in settings for Google.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Database Sign-In Settings for Google

Enable or disable database sign-in for Google. You must first configure the Google identity provider and enable database sign-in for external server accounts.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for database sign-in for Google

EnableGoogleSignin
required
boolean

Allows you to enable or disable database sign-in for Google.

Responses

Request samples

Content type
application/json
{
  • "EnableGoogleSignin": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Database Sign-In Settings for Microsoft

Get database sign-in settings for Microsoft.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Database Sign-In Settings for Microsoft

Enable or disable database sign-in for Microsoft Azure. You must first configure the Microsoft Azure identity provider and enable database sign-in for external server accounts.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for database sign-in for Microsoft Azure

EnableMSSignin
required
boolean

Allows you to enable or disable database sign-in for Microsoft Azure.

Responses

Request samples

Content type
application/json
{
  • "EnableMSSignin": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Database Sign-In Settings for AppleID

Get database sign-in settings for AppleID.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Database Sign-In Settings for AppleID

Enable or disable database sign-in for AppleID. You must first configure the AppleID identity provider and enable database sign-in for external server accounts.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for database sign-in for AppleID

EnableAppleIDSignin
required
boolean

Allows you to enable or disable database sign-in for AppleID.

Responses

Request samples

Content type
application/json
{
  • "EnableAppleIDSignin": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Database Sign-In Settings for Custom OAuth

Get database sign-in settings for Custom OAuth.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update Database Sign-In Settings for Custom OAuth

Enable or disable database sign-in for Custom OAuth. You must first configure the Custom OAuth identity provider and enable database sign-in for external server accounts.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for database sign-in for Custom OAuth

EnableCustomOAuthSignin
required
boolean

Allows you to enable or disable database sign-in for Custom OAuth.

Responses

Request samples

Content type
application/json
{
  • "EnableCustomOAuthSignin": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

FileMaker Client Settings

FileMaker Pro and FileMaker Go Session Timeout Setting

Get the session timeout setting for FileMaker Pro and FileMaker Go.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update FileMaker Pro and FileMaker Go Session Timeout

Update the session timeout setting for FileMaker Pro and FileMaker Go.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

FileMaker Pro and FileMaker Go session timeout parameters

enableProGoTimeout
required
boolean

Indicates if there is a session timeout set for FileMaker Pro and FileMaker Go.

sessionTimeout
required
integer [ 10 .. 1440 ]

The new session timeout (in minutes) for FileMaker Pro and FileMaker Go.

Responses

Request samples

Content type
application/json
{
  • "enableProGoTimeout": true,
  • "sessionTimeout": 30
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

FileMaker WebDirect Session Timeout Setting

Get the session timeout setting for FileMaker WebDirect.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update FileMaker WebDirect Session Timeout

Update the session timeout setting for FileMaker WebDirect.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

FileMaker WebDirect session timeout parameters

sessionTimeout
required
integer [ 1 .. 60 ]

The new session timeout (in minutes) for FileMaker WebDirect.

Responses

Request samples

Content type
application/json
{
  • "sessionTimeout": 10
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get Database Filtering Setting

Get the database filtering setting for FileMaker Pro, FileMaker Go, FileMaker WebDirect, and FileMaker Data API.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable Database Filtering

Enable or disable filtering the list of databases shown in the FileMaker Pro Hosts dialog box, in the FileMaker Go and the FileMaker WebDirect Launch Center, and in the FileMaker Data API Database Names endpoint based on the FileMaker client account name and password.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for enabling or disabling filtering the list of databases

databaseVisibility
required
boolean

Allows you to enable or disable filtering the list of databases.

Responses

Request samples

Content type
application/json
{
  • "databaseVisibility": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get HTTPS Tunneling Setting

Get the https tunneling setting for FileMaker Pro and FileMaker Go.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable HTTPS Tunneling

Enable or disable https tunneling for FileMaker Pro and FileMaker Go.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Parameters for enabling or disabling https tunneling

enableHTTPSTunneling
required
boolean

Allows you to enable or disable https tunneling.

Responses

Request samples

Content type
application/json
{
  • "enableHTTPSTunneling": true
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

OData

OData Settings

Get the OData settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Update OData Settings

Update the OData settings.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

OData Configuration Parameter

enabled
required
boolean

If used with GET, specifies whether OData is enabled or disabled. If used with PATCH, allows you to enable or disable OData.

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

SSL Certificate

Create SSL CSR

Create CSR file.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

CSR information Parameter

subject
required
string

Base64encoded CSR subject information.

password
required
string

Password for private key, flat text.

ecparam
string
Enum: "prime256v1" "secp384r1" "secp521r1"

To use the elliptic curve cryptography (ECC) instead of the Rivest-Shamir-Adleman (RSA) algorithm, set the value to one of these supported curves. To use RSA, simply omit this parameter.

Responses

Request samples

Content type
application/json
{
  • "subject": "L0NOPXd3dy5teWRvbS5jb20vTz1NeSBEb20sIEluYy4vQz1VUy9TVD1PcmVnb24vTD1Qb3J0bGFuZA==",
  • "password": "FileMaker123",
  • "ecparam": "prime256v1"
}

Response samples

Content type
application/json
{
  • "response": { },
  • "messages": [
    ]
}

Get Server Certificate Information

Get the server certificate information.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Import SSL Certificate

Import an SSL certificate to the database server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

SSL certificate information parameter

certificate
required
string

SSL certificate content as a single line with '\n' text to indicate a line break.

privateKey
required
string

SSL private key content as a single line with '\n' text to indicate a line break.

expiredCertificate
boolean

optional, force to accept expired ceritificate.

intermediateCertificates
string

optional, intermediate SSL certificate content as a single line with '\n' text to indicate a line break.

password
string

optional, certificate password.

Responses

Request samples

Content type
application/json
{
  • "certificate": "-----BEGIN CERTIFICATE-----\nMIID4zCCAssCAQEwDQYJKoZIhvcNAQELBQAwgc8xCzAJBgNVBAYTAlVTMSIwIAYD\nVQQLDBlDbGFyaXMgSW50ZXJuYXRpb25hbCBJbmMuMTQwMgYDVQQLDCtDb3B5cmln\naHQoYykgMjAyMSBDbGFyaXMgSW50ZXJuYXRpb25hbCBJbmMuMSIwIAYDVQQKDBlD\nbGFyaXMgSW50ZXJuYXRpb25hbCBJbmMuMR4wHAYDVQQDDBVDbGFyaXMgUm9vdCBB\ndXRob3JpdHkxIjAgBgkqhkiG9w0BCQEWE3NlY3VyaXR5QGNsYXJpcy5jb20wHhcN\nMjEwOTI2MDI1NTM3WhcNMjIwOTI2MDI1NTM3WjCBnjELMAkGA1UEBhMCVVMxEzAR\nBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAcMC1NhbnRhIENsYXJhMSIwIAYDVQQK\nDBlDbGFyaXMgSW50ZXJuYXRpb25hbCBJbmMuMUAwPgYDVQQDDDdDbGFyaXMgU2Vs\nZiBTaWduZWQgQ2VydGlmaWNhdGUgKE5vdCBmb3IgUHJvZHVjdGlvbiBVc2UpMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArqyCHTzo7lwUw9k50RivXUmx\nLUAh982UAfoPhCpeux7LKAm1rp/EWzEzxvrUBrUFX8oOeFY6PWrBy1KjBWkb4H5S\nyItPb7vES9IcMcPNBY06W7UEjnvcLvL99OewvfEj7J7qUWhFjjUV7yn2/cLEC1LI\ntwVWvPMhKGe3x5t+xroFYbnJx5S8KaVTz+VrZK4HrcK7Jx3MIs07PUcIMhH/jgSZ\nJIaSk3yAaw7hN12ljKvhULhCtOGNyEoCNZ9GzklDGZyl7Lz8e01IUlBUhf6sXmes\nabxoXK7XwMx8Y1Stfa4rAbFeKxVDV8goCbshLaUVn8xk4JQZAmqJtjV4l0rrEQID\nAQABMA0GCSqGSIb3DQEBCwUAA4IBAQAjYoZ4Ra6VKI8tb2f1ZBv2miCxba+COcS+\nwWphPfbE/Z4Tyv8gPX39gRIwWd8wPVpvF9qAG8rYjDlDEv+4vZMF4/NF2Gg0l9Gg\n6TXvBJ8YeZ6RmYIyBp8NVWAPwF7pGodjVUi5cuUbTcLeiW+sOPVYegkhg3zNykGw\nqGl8tFFxA9al/0GzEvINVt0N5fJqnrSw9MKb2+rfBP6/hy0UfsupWv2V1Ju+rqlq\ngBE6+PbqcORGn0dib3rFsQKMFd4cg5qQzd77bMXVAckArLQ6ABw9/XP/ESYARscI\nRp5HnPIddE7Z/AJFjWqC03cfWu1mIDhlkwFkK1r04L0pQWXy2UCF\n-----END CERTIFICATE-----",
  • "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQCurIIdPOjuXBTD\n2TnRGK9dSbEtQCH3zZQB+g+EKl67HssoCbWun8RbMTPG+tQGtQVfyg54Vjo9asHL\nUqMFaRvgflLIi09vu8RL0hwxw80FjTpbtQSOe9wu8v3057C98SPsnupRaEWONRXv\nKfb9wsQLUsi3BVa88yEoZ7fHm37GugVhucnHlLwppVPP5WtkrgetwrsnHcwizTs9\nRwgyEf+OBJkkhpKTfIBrDuE3XaWMq+FQuEK04Y3ISgI1n0bOSUMZnKXsvPx7TUhS\nUFSF/qxeZ6xpvGhcrtfAzHxjVK19risBsV4rFUNXyCgJuyEtpRWfzGTglBkCaom2\nNXiXSusRAgMBAAECggEBAJsbrN7xu5YORpIzT1gSJ4cbbS3ViVRXRVsMBsNCLKTV\nD2oaVS8fyGmCI4xKKAVcsc0BzB+n0ke/iR9X3lNrpsmO40waCQwbHJCHn2nBiUmo\nw220LLup2TgHpuPW6eeBPnlcFI79nOZO1Y9vIFjuns+/T2TWZNOcwpDyqQujVMx5\n44MhDdemoN/rIQPYWH7irk72jLkj0ssDbzjB5WF7Yvzn+pl3oYNAthQRcKn/rzUI\n2L+2N0JcKBxp7/Soc5CADOjX87LfjY3yCucqwhFsU7kfoz+gJCA+LpmBMAyJUHAm\nXfHhrVkyhMXKZ5BQbmqQ8h7yDkfwwTf0ARYG1PkiSQECgYEA24nNDcxCWy1+MVY6\nS6Yhj6a//RO8FvCPMWkl+3k4eQ9A0c/BXfiDVryiWSQVqJbFUJjc1RH7yroxc/Ei\nCSSePfzE409XWL98Cg8Cs1D2AQI2v1PJijNmw+eW06StskHOHwrgt2Q6LGKjZQut\nkYr/jifLtPuxuI+4/ku5PGwL7bkCgYEAy68wLKTauceBqRZDqOOA2bYnltsyN57r\n1shaR3WT8yo9UHu8KnCg05UEkqcea/f+iliZOFqd7OUoxwCV6LldeC9Hghi2CFJe\nN2CuRwvC6jkkrYiEXisZ8lj9l6bW2uLzo57WkSgXHhmfhWC60GRXzk9AD7qoqGBM\n9oMaIDEgVBkCgYA2S047K1j907Jx4TFppByIumSg4lCSG8xOHAMYvlIJHoyZVxgr\ndVqGCQDdqt7wYtlJpYR37YqoCIRSeEBCopvAGNNYpDal7DVxB2VTk6JDfZismLwv\nQacYrB3RGdkbTMr9QmNw94irkXl3c/vpEsdBEPaAO/8n9eN6gJ+/IbmRgQKBgQCF\nWUp2z+8K1dzDcHoXZeqDnkfI8fSsiXTphv3j7sxP1IWT3Y5RUq9YFiWKRbMbCJ8y\nv9KAHINsBpNtxapfVIwnFP0B5V+3jwVzx+4RQVf4tDSZD9lpNVqlWTGdSXM8lnzf\n0Cu1mMOZxziyv6NOr4L05NmR8qhco79/XFGMZd0+cQKBgQCtbM5f/7GvThR4H7rc\nX0T8ybbF/QGq5ZM8/9Gt28G6BWvuRPsPsq1zmHNT3ZYNFxvcuT6sWz94K8JqBmU2\nW71PSp7GuwfHhYMEYdctzjteEAdq1XgMX2He6ov2z5cw+RBrN1ysr7+Zi6O3q/eC\n8rkL6d57SfISJXVsUjsjhU7/7w==\n-----END PRIVATE KEY-----",
  • "expiredCertificate": true
}

Response samples

Content type
application/json
{
  • "response": { },
  • "messages": [
    ]
}

Import SSL Certificate Files

Import SSL certificate files to the database server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Request Body schema: multipart/form-data
certfile
required
string <binary>

SSL certificate file.

keyfile
required
string <binary>

SSL private key file.

intermediatefile
string <binary>

optional, intermediate SSL certificate file.

password
string

optional, certificate password.

Responses

Response samples

Content type
application/json
{
  • "response": { },
  • "messages": [
    ]
}

Delete SSL Certificate

Delete the SSL certificate from the database server.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": { },
  • "messages": [
    ]
}

FMPlugins

Get Plug-in List

List installed plug-ins.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "result": 0,
  • "messages": [
    ]
}

Enable/Disable Individual Plug-in

Enable or disable an installed plug-in.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

Plug-in configuration parameter

id
required
string

The plug-in ID

enabled
required
boolean

Allows you to enable or disable plug-in.

Responses

Request samples

Content type
application/json
{
  • "id": "1",
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable WPE Install Plug-in Script

Enable or disable Web Publishing Engine install plug-in script

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

WPE Allow Install Plug-in Script Step Configuration Parameter

iwpAllowInstallPlugins
required
boolean

Allows you to enable or disable install plug-in script step for WPE.

Responses

Request samples

Content type
application/json
{
  • "iwpAllowInstallPlugins": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable WPE Plug-ins

Enable/Disable Web Publishing Engine Plug-ins

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

WPE Plug-in Configuration Parameter

iwpEnablePlugins
required
boolean

Allows you to enable or disable WPE plug-in.

Responses

Request samples

Content type
application/json
{
  • "iwpEnablePlugins": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable DBS Install Plug-ins Script

Enable/Disable Database Server install plug-ins script

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

DBS Allow Install Plug-in Script Step Configuration Parameter

allowInstallPlugin
required
boolean

Allows you to enable or disable install plug-in script step for DBS.

Responses

Request samples

Content type
application/json
{
  • "allowInstallPlugin": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable DBS Plug-ins

Enable or disable database server plug-ins.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

DBS Plug-in Configuration Parameter

usePlugins
required
boolean

Allows you to enable or disable DBS plug-in.

Responses

Request samples

Content type
application/json
{
  • "usePlugins": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable DAPI Install Plug-in Script

Enable or disable Data API install plug-in script

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

DAPI Allow Install Plug-in Script Step Configuration Parameter

DAPIAllowInstallPlugins
required
boolean

Allows you to enable or disable install plug-in script step for DAPI.

Responses

Request samples

Content type
application/json
{
  • "DAPIAllowInstallPlugins": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Enable/Disable DAPI Plug-ins

Enable/Disable Data API Plug-ins

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Content-Type
required
string
Value: "application/json"

Only accepts 'application/json'.

Request Body schema: application/json

DAPI Plug-in Configuration Parameter

DAPIEnablePlugins
required
boolean

Allows you to enable or disable DAPI plug-in.

Responses

Request samples

Content type
application/json
{
  • "DAPIEnablePlugins": false
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get DBS Plug-in Configuration

Get database server plug-in configuration.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get WPE Plug-in Configuration

Get Web Publishing Engine plug-in configuration.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}

Get DAPI Plug-in Configuration

Get Data API plug-in configuration.

header Parameters
Authorization
required
string

To use the Basic Authentication scheme, include an Authorization header with the value Basic <base64-encoded string>. The base64-encoded string should be generated based on username:password.

To use the PKI Authentication scheme, include an Authorization header with the value PKI <PKI-token>. The string should be generated by the FileMaker Admin API PKI Authentication scripts.

  • If you use the Basic Authentication or PKI Authentication scheme for the Authentication endpoint, the request returns the JSON Web Token in the response body.
  • If you use the Basic Authentication or PKI Authentication scheme for other endpoints, the request returns the JSON Web Token in the X-FM-Access-Token field in the response header.
  • For subsequent API calls, use the Bearer Authentication scheme and include an Authorization header with the value Bearer <JSON Web Token>.

Note: Each time you use the Basic Authentication or PKI Authentication scheme to get a JSON Web Token, a new API session is created. To avoid having multiple API sessions, use the same JSON Web Token with the Bearer Authentication scheme for all API calls.

Responses

Response samples

Content type
application/json
{
  • "response": {
    },
  • "messages": [
    ]
}