OttoFMS API - Apply patch files to a file

Requires FileMaker Server 26 or later. Closes a hosted file, backs it up, applies the supplied patch files in order using FMUpgradeTool, reverts to the backup if any patch fails, then reopens the file. Runs asynchronously — returns a processId to track progress.

Request Body

application/json

POST /otto/api/fm-file/apply-patch Request body

account*string

Full Access or 'fmupgrade' account for the source file

closeMessage?string

Message shown to connected clients when the file is closed

Lengthlength <= 200

encryptionKey?string

EAR password, required for encrypted files

password*string

Password for the source account

patches*array<>

Patch files applied sequentially in array order

Items1 <= items

targetFile*string

Name of the hosted FileMaker file to apply the patches to

Match.fmp12

Response Body

`application/json`

curl -X POST "https://your.server.net/otto/api/fm-file/apply-patch" \
  -H "Content-Type: application/json" \
  -d '{
    "account": "string",
    "password": "string",
    "patches": [
      {
        "contentsBase64": "string",
        "name": "string"
      }
    ],
    "targetFile": "string"
  }'

curl -X POST "https://your.server.net/otto/api/fm-file/apply-patch" \  -H "Content-Type: application/json" \  -d '{    "account": "string",    "password": "string",    "patches": [      {        "contentsBase64": "string",        "name": "string"      }    ],    "targetFile": "string"  }'

{
  "messages": [
    {
      "code": 0,
      "text": "ok"
    }
  ],
  "response": {}
}

{
  "messages": [
    {
      "code": 18011,
      "text": "OttoFMS sample error"
    }
  ],
  "response": {}
}

Was this page helpful?

Apply patch files to a file

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`