OttoFMS API - Create a build

Request Body

application/json

POST /otto/api/build Request body

buildId?string

Default"build_id_missing"

chainedAction?||array<|>

closeFiles?boolean

Close files before backing up. This setting is ignored for clones. If the file is encrypted, it will be closed and reopened with the encryption key.

compressionLevel?integer

The compression level used by OttoFMS to compress the build zip. Higher values of this will make the zip smaller but will use more resources. Lower values will keep the .zip file big but will use less resources.

Range-1 <= value <= 9

ensureFilesOpen?boolean

If true, OttoFMS will ensure that the files are open at the end of the build. This is useful if the files were closed when the build started but you want to ensure they are open when the build is complete.

fileConfig?||

If provided, OttoFMS will collect file configuration (notes, webhooks, MCP servers) and include it alongside each file in the manifest.

files?array<>

Array of FileMaker files to include in the build

Items1 <= items

force?boolean

includeContainerData?boolean

If true, OttoFMS will add external container data for copies to the build. This is useful for installations that need to preserve container data.

includeCredentialsInManifest?boolean

If true, the credentials will be included in the manifest. This is primarily useful for public builds that need credentials to be available with the files.

memoryLevel?integer

The amount of memory used by OttoFMS to zip the build. Higher values will let the process use more memory to zip and will make the process faster. Lower values will use less memory and will make the process slower.

Default1

Range1 <= value <= 9

notifications?unknown

postDeploymentScript?

Script to be run after deployment (stored in manifest for future use)

preBuildScript?

Script to be run before files are closed or backed up

preDeploymentScript?

Script to be run before deployment (stored in manifest for future use)

publish?

textFiles?array<>

Array of text files to include in the build zip

zipFiles?boolean

If true, OttoFMS will zip the files. If false, OttoFMS will not zip the files. If this is false, the build will only work for local deployments or actions, not for remote deployments or for publishing elsewhere using OttoFMS.

Defaulttrue

scheduled*boolean

boolean to determine whether or not to schedule the deployment(s) for later

timestamp*string

timestamp to use to schedule the deployment. See Claris FileMaker scheduling API docs for formatting.

Match^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])

Response Body

`application/json`

curl -X POST "https://your.server.net/otto/api/build" \
  -H "Content-Type: application/json" \
  -d '{
    "buildId": "build_id_missing",
    "files": [
      {
        "fileName": "string"
      }
    ],
    "scheduled": true,
    "timestamp": "string"
  }'

curl -X POST "https://your.server.net/otto/api/build" \  -H "Content-Type: application/json" \  -d '{    "buildId": "build_id_missing",    "files": [      {        "fileName": "string"      }    ],    "scheduled": true,    "timestamp": "string"  }'

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

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

Create a build

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`