Waiting for engine...
Skip to main content

Boomi MFT - File Sharing API Reference (1.16) - Server

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Server Service

The Server Configuration REST Web Services provide endpoints for retrieving detailed information about the current server and its operational settings. These APIs return server metadata, allowed bandwidth and bandwidth interval parameters, and configuration details for key subsystems, including message, password, upload, and mobile settings.

Retrieve Server Information

Retrieves information about current server.

Invocation Scenarios

Get file information in order to fulfill it.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
Enabled
required
boolean

Indicate is the site enabled

Name
required
string

Pretty name of the current site

SiteID
required
integer <int32>

Identifier of the current site

Title
required
string

Title of the site

Welcome
required
string

‘Welcome’ text of the site

Response samples

Content type
application/json
{
  • "SiteID": "14RD6GNEUV4ZV",
  • "Name": "test.example.com",
  • "Title": "MFT Site name",
  • "Welcome": "Welcome",
  • "Enabled": true
}

Retrieve Server Sync Policy

Server Sync Policy

Authorizations:
SessionAuth

Responses

Response Schema: application/json
DeleteSynchedLocalFilesOnAccountDeletion
required
boolean

Settings for Sync client: indicate client to delete local files if user account is deleted on server

DeleteSynchedLocalFilesOnAccountDisabled
required
boolean

Settings for Sync client: indicate client to delete local files if user account is disabled on server

FullSyncIntervalMinutes
required
boolean

Settings for Sync client: interval between calls for full sync

SavePasswordLocal
required
boolean

Settings for Sync client: indicate client to store user password for MFT server on local machine

Response samples

Content type
application/json
{
  • "DeleteSynchedLocalFilesOnAccountDisabled": true,
  • "DeleteSynchedLocalFilesOnAccountDeletion": true,
  • "SavePasswordLocal": true,
  • "FullSyncIntervalMinutes": true
}

Retrieve Server Allowed Bandwidth

Server Allowed Bandwidth

Authorizations:
SessionAuth

Responses

Response Schema: application/json
MaxAllowedBandwidthKBps
required
string

Max allowed bandwidth for client in Kbits/s

Response samples

Content type
application/json
{
  • "MaxAllowedBandwidthKBps": "1024"
}

Retrieve Server Allowed Bandwidth interval

Server Allowed Bandwidth interval

Authorizations:
SessionAuth

Responses

Response Schema: application/json
AllowedBandwidthRequestIntervalMB
required
string

Interval in MB between calls to retrieve actual value of ThruAllowedBandwidth

Response samples

Content type
application/json
{
  • "AllowedBandwidthRequestIntervalMB": "100"
}

Retrieve Message Settings

Retrieves information about message settings in the server.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
AllowSetAfterDefaultExpirationInterval
required
boolean

Allow to specify the message expiration interval larger than default

DefaultExpirationIntervalDays
required
integer <int32>

Default expiration interval in Days

ExpiredMsgNotificationEnabled
required
boolean

Enable expired message notification

MsgRequestLoginType
required
integer <int32>

1 – Never (No registration for external download) 2 – Always (external download always requires registration) 3 – User Choice (request login is turned off by default but the user can turn it on when sending a message)

MsgRequestloginUserChoiceDefault
required
boolean

If request recipient login is ‘User Choice’ – turn on request login as default value for a new message.

SeparateEmailsLimit
required
integer <int32>

For tracking purposes, the system creates separate emails per recipient if the message requires a link to MFT server and request login is turned off. This parameter prevents massive email generation.

SmtpServerRecipientLimit
required
integer <int32>

If your SMTP server has a limit, and the limit is entered here, MFT server will block messages which exceed the limit. If the limit is NOT entered here, and a message exceeds recipient limit, SMTP server will send the message with a partial recipient list and the user will get an error message.

WebUseMsgPwdInsteadOfRequestLogin
required
boolean

On the web interface, use message password instead of recipient login. This option only allowed if Request recipient login’ is ‘Never’.

Response samples

Content type
application/json
{
  • "SeparateEmailsLimit": 1000,
  • "SmtpServerRecipientLimit": 0,
  • "MsgRequestLoginType": 3,
  • "MsgRequestloginUserChoiceDefault": false,
  • "ExpiredMsgNotificationEnabled": true,
  • "WebUseMsgPwdInsteadOfRequestLogin": false,
  • "DefaultExpirationIntervalDays": 10,
  • "AllowSetAfterDefaultExpirationInterval": false
}

Retrieve Password Settings

Retrieves information about password settings in the server

Authorizations:
SessionAuth

Responses

Response Schema: application/json
AutomaticExpiration
required
boolean

Enable/Disable automatic password expiration

AutomaticLoginLockout
required
boolean

Enable/Disable automatic login lockout

BlockPreviousPasswords
required
boolean

Do not allow reuse of previous passwords

ExpirationDays
required
integer <int32>

Expiration days

ExpirationWarningNotificationDays
required
integer <int32>

Send expiration warning notification – warning days

LockoutDurationSeconds
required
integer <int32>

Lockout duration seconds

MaxLoginAttempts
required
integer <int32>

Max login attempts

MinimumPasswordLength
required
integer <int32>

Minimum password length

PreviousPasswordCount
required
integer <int32>

Number of previous passwords to check

RequireDigit
required
boolean

At least one digit required

RequireLetter
required
boolean

At least one letter required

RequireLowercaseLetter
required
boolean

At least one lowercase letter required

RequireSpecialCharacter
required
boolean

At least one special character required

RequireUppercaseLetter
required
boolean

At least one uppercase letter required

Response samples

Content type
application/json
{
  • "AutomaticExpiration": true,
  • "ExpirationDays": 10,
  • "ExpirationWarningNotificationDays": 0,
  • "AutomaticLoginLockout": true,
  • "MaxLoginAttempts": 5,
  • "LockoutDurationSeconds": 20,
  • "BlockPreviousPasswords": false,
  • "PreviousPasswordCount": 3,
  • "MinimumPasswordLength": 6,
  • "RequireSpecialCharacter": false,
  • "RequireLetter": false,
  • "RequireDigit": false,
  • "RequireUppercaseLetter": false,
  • "RequireLowercaseLetter": false
}

Retrieve Upload Settings

Retrieves information about upload settings in the server.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
UploadAppletBatchMaxCount
required
integer <int32>

The maximum number of files uploaded in batch by the applet to the server in a single HTTP request. To indicate that there is no limit, use the value 0.

UploadAppletChunkCount
required
integer <int32>

The maximum number of chunks to divide a file to be uploaded by the applet, before we start increasing the chunk size from the minimum size.

UploadAppletChunkMaxSizeMb
required
integer <int32>

The maximum size (in Megabytes) of a file chunk uploaded by the applet to the server.

UploadAppletChunkMinSizeMb
required
integer <int32>

The minimum size (in Megabytes) of a file chunk uploaded by the applet to the server.

UploadAppletDeleteOnCancelDefault
required
boolean

Indicates whether the default behavior for the applet on an upload cancellation is to delete partially uploaded files.

UploadAppletDeleteOnCancelEnabled
required
boolean

Indicates whether the user can opt on the behavior for the applet on an upload cancellation. If true, user can opt; false, otherwise.

UploadAppletZippingEnabled
required
boolean
UploadAppletZippingMinFileSizeKb
required
integer <int32>

Response samples

Content type
application/json
{
  • "UploadAppletBatchMaxCount": 0,
  • "UploadAppletChunkCount": 20,
  • "UploadAppletChunkMaxSizeMb": 100,
  • "UploadAppletChunkMinSizeMb": 60,
  • "UploadAppletDeleteOnCancelDefault": false,
  • "UploadAppletDeleteOnCancelEnabled": true,
  • "UploadAppletZippingEnabled": false,
  • "UploadAppletZippingMinFileSizeKb": 10
}

Retrieve Mobile settings

Retrieves information about mobile settings in the server.

Authorizations:
SessionAuth

Responses

Response Schema: application/json
EnableOpenInAnotherApplication
required
boolean
LocalSessionOfflineLifetimeSeconds
required
integer <int32>
MobilePolicyUpdateIntervalSeconds
required
integer <int32>
SessionRecheckIntervalSeconds
required
integer <int32>

Response samples

Content type
application/json
{
  • "SessionRecheckIntervalSeconds": 60,
  • "EnableOpenInAnotherApplication": true,
  • "LocalSessionOfflineLifetimeSeconds": 180,
  • "MobilePolicyUpdateIntervalSeconds": 300
}