Database upload event

Use this API call to begin, end, or cancel uploading, or to add any errors to the event log.

HTTP method

GET

HOST URL

https://instance-name

API call URL

/fmws/Secure/DatabaseFilename
HTTP header
  • x-fms-command: The command for the API call. For this header, "databaseuploadevent" is the only value allowed.
  • x-fms-session-key (string): The session key returned from the Authentication API call.
  • x-fms-upload-event (integer): The event for the API call. Possible values are:
    • 1 - DatabaseUploadEventBegin: FileMaker Cloud prepares the host for uploading.
    • 2 - DatabaseUploadEventEnd: FileMaker Cloud verifies the information and moves the files to the hosting area.
    • 3 - DatabaseUploadEventCancel: FileMaker Cloud cancels uploading and removes the temporary folders.
    • 4 - DatabaseUploadEventError: FileMaker Cloud reports any error messages in the event log.
  • x-fms-encrypted-password (a base64-encoded string): The encryption password for the database to be uploaded after this call.
  • x-fms-save-earkey: If set to 1, FileMaker Cloud saves the encryption password for the uploaded database, so users don't need to enter the encryption password when they open the database.
Body Empty
Parameters None

Response

body

The API call result code.

For example:

"result": 0
Response header

Check the response header for any error codes.

For example:

Copy 
"x-FMS-Result" : 9
"x-FMS-Error" : (9): Access was denied