Release 2019.1

1. Overview

The REST API enables you to develop, integrate, and deploy secure file transfer and management applications that leverage your organization or system-wide MOVEit Transfer solution.

Using the Transfer REST API (instead of the Transfer .NET or Java API) enables you to connect systems and clients to MOVEit Transfer using simple HTTP calls. In general, REST APIs are language and platform independent and can be your best choice to converge information systems, circumvent the unending need for client-server dependency maintenance, and span any combination of environments (including IoT, mobile, and much more).

Tip
 The REST API runs at the MOVEit Transfer Server (for example: https://<your-transfer-server>/api/v1/).
Note
 In general, this RESTful API expects the following verbs: GET (query record), POST (create/delete record), PATCH (modify/update record), or DELETE (remove record).
This REST Endpoint Provides These Resources

1.

/api/v1/token
/api/v1/token/otp

Get/renew a session token using MOVEit Transfer user credentials.
Get a one-time passcode (such as one used for a Multi-factor Authentication handshake).

2.

/api/v1/users
/api/v1/groups (GET)
/api/v1/groups (POST)

Create and manage users and groups, roles, home folders, and other properties.

3.

/api/v1/folders
/api/v1/folders{id}

Folders, folder actions, folder contents, properties, and permissions.

4.

/api/v1/mailboxes

Manage mailboxes in MOVEit Transfer.

5.

/api/v1/files
/api/v1/packages

File and package management actions and properties.

6.

/api/v1/xferstatus

Get status and summaries for ongoing and recently completed transfers.

7.

/api/v1/info

Get information about a MOVEit organization.

8.

/swagger

Live Swagger UI interactive documentation (MOVEit Transfer installation required).
Contexts

2. Before You Begin

Before you begin using the MOVEit Transfer RESTful API, you will need the following:

  • The hostname for a deployed MOVEit Transfer 2019 system.

  • Username and password for a user on the target MOVEit Transfer system.

  • Your favorite HTTP client (the examples that follow use the cURL utility).

Listener URL Purpose

Swagger UI

Browsable/interactive UI service available for exercising the REST API.

REST API

Primary REST API Endpoint.

2.1. A quick check of the API

If you are unsure whether or not the REST API is already listening for requests on a MOVEit Transfer host —here is a quick check. Type into your web browser https://<your-transfer-server>/api/v1/token. (Where <your-transfer-server> is the hostname of the MOVEit Transfer system.) If this call returns a simple JSON object, your API is running, and you can begin the steps that follow using this hostname.

Tip
 You can also use the Swagger spec object (https://<your-transfer-server>/api/v1/swagger) in tools such as Postman, Swagger Inspector, and more.

2.2. Interactive REST API Client - Swagger UI

Swagger UI libraries integrated with MOVEit Transfer at install time provide the following:

  • A way to browse the MOVEit Transfer REST documentation with live examples.

  • A simple development client for testing MOVEit Transfer REST calls.

Caution
 The examples are live calls (not simulated) that run against your database. If you are just testing and exploring the capabilities of the REST API for development purposes, it is best practice to run against a non-production instance of MOVEit Transfer.

To open the interactive MOVEit Transfer REST client:

  1. Open a browser to https://my-transfer-host/swagger/ --Where my-transfer-host is the host where you installed MOVEit Transfer

  2. Browse and build queries and view JSON result objects.

SwaggerUI

3. Getting Started

This section walks you through how to fetch user properties for the current user.

Tip
 If you are running an API token request against a non-production host with a self-signed SSL certificate needed to run HTTPS, remember to set the flag to ignore the self-signed certificate warning. (In the cURL example shown below this is the -k option.)

Step 1: Request access token

To set your session up with the MOVEit Transfer RESTful API, you must retrieve an access token. (Syntax, usage, and fields supported by the token endpoint are detailed in Retrieve API Token and Revoke API token.)

curl -k --request POST --url https://your-transfer-server/api/v1/token --data "grant_type=password&username=emmacurtis&password=1a2B3cA1b2C3"

Example Output

{
  "access_token": "X03w.....dziTwmA",
  "token_type": "bearer",
  "expires_in": 86399,
  "refresh_token": "X03w.....dziTwmA"
}

--Where your-transfer-server is the hostname where your MOVEit Transfer WebUI is running.
--And, where you supply values for the username and password (such as the MOVEit user you created for this RESTful client application).

Step 2: Get my user ID

Now, pass the access token as a header argument, type "Bearer" and get your user information.

curl -H "Authorization: Bearer X03w.....dziTwmA"  "https://your-transfer-server/api/v1/users/self"

--Where your-transfer-server is the hostname where your MOVEit Transfer WebUI is running.
--And, where you should replace the placeholder string X03w…​..dziTwmA with your 278 Byte access token.

Example Output

{
	"emailFormat": "HTML",
	"notes": "",
	"statusNote": "",
	"passwordChangeStamp": "2017-04-17T09:36:47",
	"receivesNotification": "ReceivesNotifications",
	"forceChangePassword": false,
	"folderQuota": 0,
	"authMethod": "MOVEitOnly",
	"language": "en",
	"homeFolderID": 377392666,
	"defaultFolderID": 377392666,
	"expirationPolicyID": 0,
	"displaySettings": {
	   "userListPageSize": 10,
	   "fileListPageSize": 100,
	   "liveViewPageSize": 25,
	"id": "axaxfbz5v85l7dp1",
	"orgID": 9683,
	"username": "org1admin",
	"realname": "Denise Taylor",
	"permission": "Admin",
	"email": "dtaylor@example.com",
	"status": "Active",
	"lastLoginStamp": "2018-04-06T16:13:50"
}

Step 3: List files in my home folder

Now, use the homeFolderID value (311392888) and get a list of files in the folder.

curl -H "Authorization: Bearer your-access-token"  "https://your-transfer-server/api/v1/folders/311392888/files"

Example Output

{
  "items": [
    {
      "id": "455123456",
      "name": "iMacros-for-Chrome-File-Access-Setup-Mac.dmg",
      "path": "/Home/org1admin/iMacros-for-Chrome-File-Access-Setup-Mac.dmg",
      "fileSize": 4454619,
      "uploadStamp": "2018-02-08T14:48:08"
    },
    {
      "id": "455123455",
      "name": "MOVEit-Client-0.1.0-mac.zip",
      "path": "/Home/org1admin/MOVEit-Client-0.1.0-mac.zip",
      "fileSize": 61725986,
      "uploadStamp": "2018-02-08T08:58:45"
    }
  ],
  "currentPage": 1,
  "totalItems": 2,
  "itemsPerPage": 25,
  "sorting": [
    {
      "sortField": "name",
      "sortDirection": "asc"
    }
  ]
}

4. Handling Session Tokens

Before you can be authorized to access MOVEit Transfer resources using this RESTful API, you must request an access token. Only authenticated clients can fetch or renew an access token.

4.1. Request/refresh an access token

HTTPS sessions with MOVEit Transfer begin with a token request. It must be sent as an HTTP POST.

POST /api/v{version}/token

4.1.1. Request Example

Tip
 If you are running an API token request against a non-production host with a self-signed SSL certificate needed to run HTTPS, remember to set the flag to ignore the self-signed certificate warning. (In the cURL example shown below this is the -k option.) 
curl -k --request POST --url https://mydmzserver/api/v1/token --data "grant_type=password&username=${username}&password=${password}"

--Where mydmzserver is the hostname where your MOVEit Transfer WebUI is running.
--And, where ${username} and ${password} are the username and password you created for the current client application.

Note
 For logging purposes, it is best practice to create an new API user using the MOVEit Transfer WebUI.

4.1.2. Refresh Example

curl -X POST https://mydmzserver/api/v1/token -H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=refresh_token&refresh_token=${refresh-token}"

--Where mydmzserver is the hostname where your MOVEit Transfer WebUI is running.
--And, where ${refresh-token} is the token received from the last authenticated token request (this request must be submitted within the allowed expiration period).

Tip
 Token expiration duration is determined by client session properties configured at the MOVEit Transfer Server.

4.2. Token response messages

Response Content Type: application/json

HTTP Status Code Meaning Response Model

200

SUCCESS

{
"access_token": "_acaxffz2p3cl1ek8…​",
"token_type": "bearer",
"expires_in": 86399,
"refresh_token": "_ACAXFFZ2P3CL1EK8U…​",
}

400

BAD REQUEST

{
"error": "invalid_grant",
"error_description": "Invalid username/password or not allowed to sign on from this location."
}

4.3. Use token in request

After you get your session token you can use the token in subsequent requests. You pass the token in the HTTP header as type Bearer. For example, to get information such as user directory, name, user ID, and more for the current user, you would send this cURL GET request that passes the token using the -H option.

4.3.1. Example

curl -H "Authorization: Bearer X03w....dziTwmA"  'https://mydmzserver/api/v1/users/self"

--Where mydmzserver is the hostname where your MOVEit Transfer WebUI is running.

5. Paths

5.1. Get list of files current user can view

GET /api/v1/files

5.1.1. Parameters

Type Name Description Schema

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Name of field to sort the results by. (name, size, datetime, uploadstamp or path); Default is Path.

string

5.1.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.1.3. Produces

  • application/json

  • text/json

5.1.4. Tags

  • Files

5.1.5. Security

Type Name

apiKey

5.2. Return file details

GET /api/v1/files/{Id}

5.2.1. Parameters

Type Name Description Schema

Path

Id
required

File ID

string

5.2.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.2.3. Produces

  • application/json

  • text/json

5.2.4. Tags

  • Files

5.2.5. Security

Type Name

apiKey

5.3. Delete file

DELETE /api/v1/files/{Id}

5.3.1. Parameters

Type Name Description Schema

Path

Id
required

File ID

string

5.3.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.3.3. Produces

  • application/json

  • text/json

5.3.4. Tags

  • Files

5.3.5. Security

Type Name

apiKey

5.4. Partial file update

PATCH /api/v1/files/{Id}

5.4.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the file to update

string

Body

body
required

Request body.

5.4.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.4.3. Consumes

  • application/json

  • text/json

5.4.4. Produces

  • application/json

  • text/json

5.4.5. Tags

  • Files

5.4.6. Security

Type Name

apiKey

5.5. Copy file into another folder

POST /api/v1/files/{Id}/copy

5.5.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the file to copy

string

Body

body
required

File copy request details

5.5.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

404

Resource Not Found

409

Operation Conflicted

500

Server Error

5.5.3. Consumes

  • application/json

  • text/json

5.5.4. Produces

  • application/json

  • text/json

5.5.5. Tags

  • Files

5.5.6. Security

Type Name

apiKey

5.6. Download file

GET /api/v1/files/{Id}/download

5.6.1. Parameters

Type Name Description Schema

Path

Id
required

File ID

string

5.6.2. Responses

HTTP Code Description Schema

200

OK

file

403

Forbidden

500

Server Error

5.6.3. Produces

  • application/octet-stream

5.6.4. Tags

  • Files

5.6.5. Security

Type Name

apiKey

5.7. Get list of folders current user can view

GET /api/v1/folders

5.7.1. Parameters

Type Name Description Schema

Query

name
optional

File name mask for filtering list of Folders

string

Query

page
optional

Page number to display

integer (int32)

Query

path
optional

File path mask for filtering list of Folders

string

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Name of field to sort the results by. (Name, Type or Path); Default is Path.

string

5.7.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.7.3. Produces

  • application/json

  • text/json

5.7.4. Tags

  • Folders

5.7.5. Security

Type Name

apiKey

5.8. Return folder details

GET /api/v1/folders/{Id}

5.8.1. Parameters

Type Name Description Schema

Path

Id
required

Folder ID

string

5.8.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.8.3. Produces

  • application/json

  • text/json

5.8.4. Tags

  • Folders

5.8.5. Security

Type Name

apiKey

5.9. Delete folder

DELETE /api/v1/folders/{Id}

5.9.1. Parameters

Type Name Description Schema

Path

Id
required

Folder ID

string

5.9.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.9.3. Produces

  • application/json

  • text/json

5.9.4. Tags

  • Folders

5.9.5. Security

Type Name

apiKey

5.10. Partial Folder update

PATCH /api/v1/folders/{Id}

5.10.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the folder to update

string

Body

body
required

Request body.

5.10.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.10.3. Consumes

  • application/json

  • text/json

5.10.4. Produces

  • application/json

  • text/json

5.10.5. Tags

  • Folders

5.10.6. Security

Type Name

apiKey

5.11. Set the Access Controls for a given folder

POST /api/v1/folders/{Id}/acls

5.11.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the folder to set access control

string

Body

body
required

Access control

5.11.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.11.3. Consumes

  • application/json

  • text/json

5.11.4. Produces

  • application/json

  • text/json

5.11.5. Tags

  • Folders

5.11.6. Security

Type Name

apiKey

5.12. Lists the Access Controls for a given folder

GET /api/v1/folders/{Id}/acls

5.12.1. Parameters

Type Name Description Schema

Path

Id
required

Folder ID

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Field to sort by; Default is name.

string

5.12.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.12.3. Produces

  • application/json

  • text/json

5.12.4. Tags

  • Folders

5.12.5. Security

Type Name

apiKey

5.13. Change the Access Controls for a given folder

PUT /api/v1/folders/{Id}/acls

5.13.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the folder to change access control

string

Body

body
required

Access control

5.13.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.13.3. Consumes

  • application/json

  • text/json

5.13.4. Produces

  • application/json

  • text/json

5.13.5. Tags

  • Folders

5.13.6. Security

Type Name

apiKey

5.14. Delete the Access Controls for a given folder

DELETE /api/v1/folders/{Id}/acls

5.14.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the folder to delete access control

string

Body

body
required

Entity type and id

5.14.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.14.3. Consumes

  • application/json

  • text/json

5.14.4. Produces

  • application/json

  • text/json

5.14.5. Tags

  • Folders

5.14.6. Security

Type Name

apiKey

5.15. Get content of the folder

GET /api/v1/folders/{Id}/content

5.15.1. Parameters

Type Name Description Schema

Path

Id
required

Parent Folder ID

string

Query

name
optional

Name mask to search by

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Field to sort by; (type, time, size or name); Sorting order starts with type and ends with name

string

5.15.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.15.3. Produces

  • application/json

  • text/json

5.15.4. Tags

  • FolderContent

5.15.5. Security

Type Name

apiKey

5.16. Upload file into folder

POST /api/v1/folders/{Id}/files

5.16.1. Description

The content type of the request must be "multipart/form-data". For large files upload (larger then maxAllowedContentLength attribute in Web.config) use chunked upload. Some clients, like Swagger and Postman, are not using chunked upload, so the upload might fail with unexpected error (404.13) More info how to setup chunked upload: https://www.ipswitch.com/Transfer2018/ChunkedUploaderExample/

5.16.2. Parameters

Type Name Description Schema

Path

Id
required

Folder ID

string

FormData

comments
optional

File upload comments

string

FormData

file
required

File contents

file

FormData

hash
optional

Hash of file

string

FormData

hashtype
optional

Type of hash provided (sha-1, sha-256, sha-384, sha-512)

string

5.16.3. Responses

HTTP Code Description Schema

201

Created

403

Forbidden

422

Invalid Request Parameters

500

Server Error

5.16.4. Consumes

  • multipart/form-data

5.16.5. Produces

  • application/json

  • text/json

5.16.6. Tags

  • FolderContent

5.16.7. Security

Type Name

apiKey

5.17. Get list of files in folder

GET /api/v1/folders/{Id}/files

5.17.1. Parameters

Type Name Description Schema

Path

Id
required

Parent Folder ID

string

Query

name
optional

File Name mask to search by

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Field to sort by; Default is name.

string

5.17.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.17.3. Produces

  • application/json

  • text/json

5.17.4. Tags

  • FolderContent

5.17.5. Security

Type Name

apiKey

5.18. Create new subfolder in folder

POST /api/v1/folders/{Id}/subfolders

5.18.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the folder where new folder should be added

string

Body

body
required

Request body.

5.18.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.18.3. Consumes

  • application/json

  • text/json

5.18.4. Produces

  • application/json

  • text/json

5.18.5. Tags

  • FolderContent

5.18.6. Security

Type Name

apiKey

5.19. Get list of subfolders in folder

GET /api/v1/folders/{Id}/subfolders

5.19.1. Parameters

Type Name Description Schema

Path

Id
required

Parent Folder ID

string

Query

name
optional

Folder Name mask to search by

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Field to sort by; Default is name.

string

5.19.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.19.3. Produces

  • application/json

  • text/json

5.19.4. Tags

  • FolderContent

5.19.5. Security

Type Name

apiKey

5.20. Get file details in folder. Redirect

GET /api/v1/folders/{folderId}/files/{fileId}

5.20.1. Parameters

Type Name Description Schema

Path

fileId
required

File ID

string

Path

folderId
required

Parent folder ID

string

5.20.2. Responses

HTTP Code Description Schema

302

Redirect

No Content

403

Forbidden

500

Server Error

5.20.3. Produces

  • application/json

  • text/json

5.20.4. Tags

  • FolderContent

5.20.5. Security

Type Name

apiKey

5.21. Download file. Redirect

GET /api/v1/folders/{folderId}/files/{fileId}/download

5.21.1. Description

The response header includes information about base64-encoded SHA1 digest value returned with file download response

5.21.2. Parameters

Type Name Description Schema

Path

fileId
required

File ID

string

Path

folderId
required

Parent folder ID

string

5.21.3. Responses

HTTP Code Description Schema

302

Redirect

No Content

403

Forbidden

422

Invalid Request Parameters

500

Server Error

5.21.4. Produces

  • application/json

  • text/json

5.21.5. Tags

  • FolderContent

5.21.6. Security

Type Name

apiKey

5.22. Get subfolder details. Redirect

GET /api/v1/folders/{parentId}/subfolders/{subfolderId}

5.22.1. Parameters

Type Name Description Schema

Path

parentId
required

Parent folder ID

string

Path

subfolderId
required

Folder ID to Get

string

5.22.2. Responses

HTTP Code Description Schema

302

Redirect

No Content

403

Forbidden

500

Server Error

5.22.3. Produces

  • application/json

  • text/json

5.22.4. Tags

  • FolderContent

5.22.5. Security

Type Name

apiKey

5.23. Delete subfolder. Redirect

DELETE /api/v1/folders/{parentId}/subfolders/{subfolderId}

5.23.1. Parameters

Type Name Description Schema

Path

parentId
required

Parent folder ID

string

Path

subfolderId
required

Folder ID to Delete

string

5.23.2. Responses

HTTP Code Description Schema

302

Redirect

No Content

403

Forbidden

500

Server Error

5.23.3. Produces

  • application/json

  • text/json

5.23.4. Tags

  • FolderContent

5.23.5. Security

Type Name

apiKey

5.24. Create new group

POST /api/v1/groups

5.24.1. Parameters

Type Name Schema

Body

body
required

5.24.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.24.3. Consumes

  • application/json

  • text/json

5.24.4. Produces

  • application/json

  • text/json

5.24.5. Tags

  • Groups

5.24.6. Security

Type Name

apiKey

5.25. Get list of groups current user can view

GET /api/v1/groups

5.25.1. Parameters

Type Name Description Schema

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

5.25.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.25.3. Produces

  • application/json

  • text/json

5.25.4. Tags

  • Groups

5.25.5. Security

Type Name

apiKey

5.26. Get a list of the members of a group

GET /api/v1/groups/{Id}/members

5.26.1. Parameters

Type Name Description Schema

Path

Id
required

Group ID

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

5.26.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.26.3. Produces

  • application/json

  • text/json

5.26.4. Tags

  • Groups

5.26.5. Security

Type Name

apiKey

5.27. Remove member from group

DELETE /api/v1/groups/{Id}/members/{UserId}

5.27.1. Parameters

Type Name Description Schema

Path

Id
required

Group ID

string

Path

UserId
required

User ID

string

5.27.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.27.3. Produces

  • application/json

  • text/json

5.27.4. Tags

  • Groups

5.27.5. Security

Type Name

apiKey

5.28. Add members(s) to group

POST /api/v1/groups/{id}/members

5.28.1. Parameters

Type Name Description Schema

Path

Id
required

Group ID

string

Body

body
required

5.28.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.28.3. Consumes

  • application/json

  • text/json

5.28.4. Produces

  • application/json

  • text/json

5.28.5. Tags

  • Groups

5.28.6. Security

Type Name

apiKey

5.29. Gets information about organization

GET /api/v1/info

5.29.1. Parameters

Type Name Description Schema Default

Query

orgId
optional

Organization ID

string

""

5.29.2. Responses

HTTP Code Description Schema

200

OK

500

Server Error

5.29.3. Produces

  • application/json

  • text/json

5.29.4. Tags

  • OrganizationInfo

5.29.5. Security

Type Name

apiKey

5.30. Retrieve mailboxes list

GET /api/v1/mailboxes

5.30.1. Responses

HTTP Code Description Schema

200

OK

< MailboxModel > array

403

Forbidden

500

Server Error

5.30.2. Produces

  • application/json

  • text/json

5.30.3. Tags

  • Mailboxes

5.30.4. Security

Type Name

apiKey

5.31. Empty trash

DELETE /api/v1/mailboxes/trash

5.31.1. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.31.2. Produces

  • application/json

  • text/json

5.31.3. Tags

  • Mailboxes

5.31.4. Security

Type Name

apiKey

5.32. Retrieve mailbox info

GET /api/v1/mailboxes/{id}

5.32.1. Parameters

Type Name Schema

Path

Id
required

string

5.32.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.32.3. Produces

  • application/json

  • text/json

5.32.4. Tags

  • Mailboxes

5.32.5. Security

Type Name

apiKey

5.33. Move package

POST /api/v1/mailboxes/{id}/packages

5.33.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the destination mailbox

string

Body

body
required

Request body.

5.33.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.33.3. Consumes

  • application/json

  • text/json

5.33.4. Produces

  • application/json

  • text/json

5.33.5. Tags

  • Mailboxes

5.33.6. Security

Type Name

apiKey

5.34. Retrieve mailbox content

GET /api/v1/mailboxes/{id}/packages

5.34.1. Parameters

Type Name Schema

Path

Id
required

string

5.34.2. Responses

HTTP Code Description Schema

200

OK

< SimplePackageModel > array

403

Forbidden

500

Server Error

5.34.3. Produces

  • application/json

  • text/json

5.34.4. Tags

  • Mailboxes

5.34.5. Security

Type Name

apiKey

5.35. Save or send package

POST /api/v1/packages

5.35.1. Parameters

Type Name Description Schema

Body

body
required

Request body.

5.35.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.35.3. Consumes

  • application/json

  • text/json

5.35.4. Produces

  • application/json

  • text/json

5.35.5. Tags

  • Packages

5.35.6. Security

Type Name

apiKey

5.36. Upload attachment.

POST /api/v1/packages/attachments

5.36.1. Description

The content type of the request must be "multipart/form-data". For large files upload (larger then maxAllowedContentLength attribute in Web.config) use chunked upload. Some clients, like Swagger and Postman, are not using chunked upload, so the upload might fail with unexpected error (404.13) More info how to setup chunked upload: https://www.ipswitch.com/Transfer2018/ChunkedUploaderExample/

5.36.2. Parameters

Type Name Description Schema

FormData

comments
optional

File upload comments

string

FormData

file
required

File contents

file

FormData

hash
optional

Hash of file

string

FormData

hashtype
optional

Type of hash provided (sha-1, sha-256, sha-384, sha-512)

string

5.36.3. Responses

HTTP Code Description Schema

201

Created

403

Forbidden

422

Invalid Request Parameters

500

Server Error

5.36.4. Consumes

  • multipart/form-data

5.36.5. Tags

  • Packages

5.36.6. Security

Type Name

apiKey

5.37. Delete attachment.

DELETE /api/v1/packages/attachments/{Id}

5.37.1. Parameters

Type Name Description Schema

Query

Id
required

File ID

string

5.37.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.37.3. Produces

  • application/json

  • text/json

5.37.4. Tags

  • Packages

5.37.5. Security

Type Name

apiKey

5.38. Get package info

GET /api/v1/packages/{Id}

5.38.1. Parameters

Type Name Description Schema

Path

Id
required

Package id

string

Query

action
optional

Package action (Reply, ReplyAll, Forward, Resend)

string

5.38.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.38.3. Produces

  • application/json

  • text/json

5.38.4. Tags

  • Packages

5.38.5. Security

Type Name

apiKey

5.39. Remove package from user’s mailboxes

DELETE /api/v1/packages/{Id}

5.39.1. Parameters

Type Name Description Schema

Path

Id
required

Package id

string

5.39.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.39.3. Produces

  • application/json

  • text/json

5.39.4. Tags

  • Packages

5.39.5. Security

Type Name

apiKey

5.40. Partial package update

PATCH /api/v1/packages/{Id}

5.40.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the package to update

string

Body

body
required

Request body.

5.40.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.40.3. Consumes

  • application/json

  • text/json

5.40.4. Produces

  • application/json

  • text/json

5.40.5. Tags

  • Packages

5.40.6. Security

Type Name

apiKey

5.41. Retrieve API token

POST /api/v1/token

5.41.1. Description

Retrieve API token

5.41.2. Parameters

Type Name Description Schema

FormData

grant_type
required

Type of authentication used

enum (password, refresh_token, otp)

FormData

language
optional

Language to use. Optional. Use with "password" or "otp" grant_type

string

FormData

mfa_access_token
optional

Multi-factor authentication access token. Use with "otp" grant_type

string

FormData

orgId
optional

Organization ID to authenticate against. Optional. Use with "password" or "otp" grant_type

string

FormData

otp
optional

One-time password. Use with "otp" grant_type

string

FormData

password
optional

User password. Use with "password" or "otp" grant_type

string

FormData

refresh_token
optional

Refresh token. Use with "refresh_token" grant_type

string

FormData

username
optional

User name. Use with "password" or "otp" grant_type

string

5.41.3. Responses

HTTP Code Description Schema

200

Represents successful token request response

400

Authentication failed error

403

Multi-factor authentication required error

5.41.4. Consumes

  • application/x-www-form-urlencoded

5.41.5. Tags

  • Authentication

5.42. Send one-time password

POST /api/v1/token/otp

5.42.1. Description

Response for send otp operation

5.42.2. Parameters

Type Name Description Schema

FormData

mfa_access_token
required

Multi-factor authentication access token

string

5.42.3. Responses

HTTP Code Description Schema

204

No content

No Content

401

Unauthorized

5.42.4. Consumes

  • application/x-www-form-urlencoded

5.42.5. Tags

  • Authentication

5.43. Revokes API token

POST /api/v1/token/revoke

5.43.1. Description

Response for Revoke token operation

5.43.2. Parameters

Type Name Description Schema

FormData

token
required

Access token or Refresh token to revoke

string

5.43.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

5.43.4. Consumes

  • application/x-www-form-urlencoded

5.43.5. Tags

  • Authentication

5.44. Create new user

POST /api/v1/users

5.44.1. Description

If SourceUserId specified in user model clone operation will be executed

5.44.2. Parameters

Type Name Schema

Body

body
required

5.44.3. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.44.4. Consumes

  • application/json

  • text/json

5.44.5. Produces

  • application/json

  • text/json

5.44.6. Tags

  • Users

5.44.7. Security

Type Name

apiKey

5.45. Get list of users

GET /api/v1/users

5.45.1. Parameters

Type Name Description Schema

Query

email
optional

User email

string

Query

fullName
optional

User real name

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

Query

permission
optional

User permission filter.

enum (AllUsers, EndUsers, Administrators, FileAdmins, GroupAdmins, TemporaryUsers, SysAdmins)

Query

realname
optional

User real name

string

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Name of field to sort the results by. (username, realname, lastLoginStamp or email); Default is username.

string

Query

status
optional

User status filter.

enum (AllUsers, ActiveUsers, InactiveUsers, NeverSignedOnUsers, TemplateUsers)

Query

username
optional

User name

string

5.45.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.45.3. Produces

  • application/json

  • text/json

5.45.4. Tags

  • Users

5.45.5. Security

Type Name

apiKey

5.46. Get current user details

GET /api/v1/users/self

5.46.1. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.46.2. Produces

  • application/json

  • text/json

5.46.3. Tags

  • Users

5.46.4. Security

Type Name

apiKey

5.47. Get user details

GET /api/v1/users/{Id}

5.47.1. Parameters

Type Name Description Schema

Path

Id
required

User ID

string

5.47.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.47.3. Produces

  • application/json

  • text/json

5.47.4. Tags

  • Users

5.47.5. Security

Type Name

apiKey

5.48. Delete user

DELETE /api/v1/users/{Id}

5.48.1. Parameters

Type Name Description Schema

Path

Id
required

User ID

string

5.48.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.48.3. Produces

  • application/json

  • text/json

5.48.4. Tags

  • Users

5.48.5. Security

Type Name

apiKey

5.49. Partial user update

PATCH /api/v1/users/{Id}

5.49.1. Parameters

Type Name Description Schema

Path

Id
required

ID of user to update

string

Body

body
required

Request body.

5.49.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.49.3. Consumes

  • application/json

  • text/json

5.49.4. Produces

  • application/json

  • text/json

5.49.5. Tags

  • Users

5.49.6. Security

Type Name

apiKey

5.50. Get list of user groups

GET /api/v1/users/{Id}/groups

5.50.1. Parameters

Type Name Description Schema

Path

Id
required

User Id.

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

5.50.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.50.3. Produces

  • application/json

  • text/json

5.50.4. Tags

  • Users

5.50.5. Security

Type Name

apiKey

5.51. Gets Transfer status information

GET /api/v1/xferstatus

5.51.1. Parameters

Type Name Description Schema

Query

fileName
optional

Filter expression for File name

string

Query

folderName
optional

Filter expression for Folder name

string

Query

page
optional

Page number to display

integer (int32)

Query

perPage
optional

Items per page in result collection

integer (int32)

Query

recentlyCompletedPeriod
optional

Time period in seconds to return recently completed data. Default: 0

integer (int32)

Query

search
optional

Filter expression for several fields. Fields are matched with OR logic. AND logic is used if you provide expression for each particular query. Fields being matched: userLoginName, userRealName, userIp, folderName, fileName

string

Query

sortDirection
optional

Sort direction; Default is ascending.

string

Query

sortField
optional

Name of field to sort the results by.

string

Query

statusDistributionPeriod
optional

Time period in seconds to calculate status distribution for. Default: RecentlyCompletedPeriod

integer (int32)

Query

transferStatus
optional

Filter for status. Uses OR logic

< enum (Failed, Stalled, Active, Completed) > array(multi)

Query

userFullName
optional

Filter expression for User Display name

string

Query

userIp
optional

Filter expression for User IP

string

Query

userLoginName
optional

Filter expression for Login name

string

Query

userRealName
optional

Filter expression for User Display name

string

5.51.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.51.3. Produces

  • application/json

  • text/json

5.51.4. Tags

  • TransferStatus

5.51.5. Security

Type Name

apiKey

6. Definitions

6.1. AddFolderModel

Name Description Schema

inheritPermissions
optional

Indicates how parent folder permissions should be inherited

enum (None, CopyOnly, Always)

name
optional

Folder name

string

6.2. AddUserModel

Name Description Schema

email
optional

User email address.

string

forceChangePassword
optional

If set to true, user must change his password on his next login.

boolean

fullName
optional

User full name.

string

homeFolderInUseOption
optional

Describes a behavior when specified home folder is already in use

enum (AllowIfExists, DenyIfExists)

homeFolderPath
optional

Path of user home folder to create. If empty no home folder will be created.

string

notes
optional

User description.

string

orgID
optional

ID of organization new user has to be member of. Will be used only when client user is SysAmin. Otherwise it will be ignored and current user orgId will be used.

integer (int32)

password
optional

User password.

string

permission
optional

User permission.

enum (TemporaryUser, User, FileAdmin, Admin, SysAdmin)

realName
optional

User full name.

string

sourceUserId
optional

Source user ID to clone from.

string

username
optional

User login name.

string

6.3. AttachmentRequest

Name Description Schema

id
optional

File ID

string

6.4. BaseGroupModel

Name Description Schema

description
optional

Additional information, related to the group.

string

id
optional

Unique ID for this group.

integer (int32)

name
optional

Name of the group.

string

6.5. CreatePackageModel

Name Description Schema

attachments
optional

List of file id’s

< SimpleFileModel > array

body
optional

Note of the package

string

deliveryReceipts
optional

Delivery receipts

boolean

derivativeId
optional

Derivative id. Use to delete draft

string

expirationHours
optional

Expiration hours

integer (int32)

isSecureBody
optional

Set true to secure package body

boolean

maxAttachDownloads
optional

Maximum downloads of attachments

integer (int32)

noReply
optional

Used to prevent reply

enum (AllowAll, DenyReplyAll, DenyAllReplies)

parentId
optional

Parent id

string

recipBCCList
optional

Recipients BCC list

< string > array

recipCCList
optional

Recipients CC list

< string > array

recipToList
optional

Recipients To list

< string > array

recipients
optional

List of recipients

< Recipient > array

subject
optional

Subject of package. Required

string

type
optional

Package type. Use Draft or template for saving package and General for sending package.

enum (General, Draft, Template)

6.6. DeleteFolderAclEntryModel

Represents delete folder Access Control List entry data suitable for all scenarios.

Name Description Schema

id
optional

ID of the entity referenced by the entry.

string

type
optional

Type of the entry.

enum (User, Group)

6.7. DisplaySettingsModel

Information about configured display setting

Name Description Schema

fileListPageSize
optional

Files/folders entries per page

integer (int32)

liveViewPageSize
optional

Live transfer entries per page

integer (int32)

userListPageSize
optional

User/group entries per page

integer (int32)

6.8. ErrorModel

Represents an error returned by API

Name Description Schema

detail
optional

An explanation specific to this occurrence of the error

string

errorCode
optional

An error number, defined by the application
Default : 0

integer (int32)

title
optional

Short summary of the error type

string

6.9. FieldErrorModel

Describes error in particular parameter of the request

Name Description Schema

field
optional

Name of the field that’s invalid

string

message
optional

Explanation of the error

string

rejected
optional

Value of the field that’s invalid

string

6.10. FileCopyRequest

File copy request details

Name Description Schema

destinationFolderId
optional

ID of the folder where to put a copy of the file

string

id
optional

File ID

string

6.11. FileDetailsModel

Represents a file and all available attributes

Name Description Schema

currentFileType
optional

Describes what type of file this file is currently.

enum (Any, Text, HTML, CSV, XML, WebPost, AuditLog, Message, MessageArchive, MessageDraft, MessageTemplate, Upload31, Upload32)

dlpBlocked
optional

When true, the file contains DLP violations that prevent it from being downloaded, according to currently configured DLP rules.

boolean

dlpChecked
optional

If true, the file was determined to not have a DLP violation; otherwise, the file was either not checked, or does contain a violation.

boolean

dlpMetaData
optional

If 1, the file�s metadata contains DLP violations, and should not be displayed. Otherwise, if 0, there are no DLP violations in the file metadata.

integer (int32)

dlpViolation
optional

File DLP violation info

string

downloadCount
optional

Number of times this file has been downloaded.

integer (int32)

folderID
optional

ID of the folder this file is currently in.

string

hash
optional

SHA-1 hash of the file

string

id
optional

The unique ID of this file. Also known as the tracking number.

string

name
optional

The name of this file.

string

orgID
optional

ID of the organization this file exists in.

string

originalFileType
optional

Describes what type of file this file was originally.

enum (Any, Text, HTML, CSV, XML, WebPost, AuditLog, Message, MessageArchive, MessageDraft, MessageTemplate, Upload31, Upload32)

originalFilename
optional

The original name of this file.

string

path
optional

The full path of this file.

string

size
optional

Size in bytes of this file.

integer (int64)

uploadAgentBrand
optional

Brand of the agent used to upload this file.

string

uploadAgentVersion
optional

Version of the agent used to upload this file.

string

uploadComment
optional

Any optional comments uploaded with this file.

string

uploadIP
optional

The IP Address, if any, from which this file was uploaded.

string

uploadIntegrity
optional

1 if file was uploaded with integrity checking, 0 if file was not.

integer (int32)

uploadStamp
optional

The date and time this file was uploaded.

string

uploadUserFullName
optional

The real name of the user account which uploaded this file.

string

uploadUserRealname
optional

The real name of the user account which uploaded this file.

string

uploadUsername
optional

The username of the user account which uploaded this file.

string

6.12. FilePatchModel

File Update parameters

Name Description Schema

name
optional

New file name to set

string

6.13. FileRequest

Name Description Schema

id
optional

File ID

string

6.14. FolderAclEntryModel

Represents folder Access Control List entry data suitable for all scenarios.

Name Description Schema

id
optional

ID of the entity referenced by the entry.

string

name
optional

Name of the entity referenced by the entry.

string

permissions
optional

Permissions set on the entry.

type
optional

Type of the entry.

enum (User, Group)

6.15. FolderAclPermissionsModel

Name Schema

addDeleteSubfolders
optional

boolean

admin
optional

boolean

deleteFiles
optional

boolean

listFiles
optional

boolean

listUsers
optional

boolean

notify
optional

boolean

readFiles
optional

boolean

share
optional

boolean

sharePermissions
optional

writeFiles
optional

boolean

6.16. FolderAclsRequest

Name Description Schema

id
optional

Folder ID

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Field to sort by; Default is name.

string

6.17. FolderContentItemModel

Represents information about items stored in folder.

Name Description Schema

folderType
optional

Indicates what kind of folder this is.

enum (Virtual, Normal, Archive, Webpost, GlobalMessaging, Mailbox, Root, RootArchives, RootWebposts)

id
optional

ID of the item.

string

isShared
optional

Indicates whether folder has been shared with someone.

boolean

lastUpdateTime
optional

Last time this item changed

string

name
optional

The name of this item.

string

parentId
optional

The ID of the parent folder.

string

path
optional

Path to this item.

string

size
optional

Size of this item in bytes.

integer (int64)

type
optional

Content Type.

enum (Folder, File)

6.18. FolderContentSqlRequest

Name Description Schema

id
optional

Parent Folder ID

string

name
optional

Name mask to search by

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Field to sort by; (type, time, size or name); Sorting order starts with type and ends with name

string

6.19. FolderDetailsModel

Represents a folder and all available attributes

Name Description Schema

allowFileOverwrite
optional

Indicates whether files of the same name will silently overwrite existing files of the same name.

boolean

cleanTimeDays
optional

Describes after how many days old files in this folder will be cleaned up.

integer (int32)

cleanType
optional

Describes what kind of automated clean up is regularly performed on this folder.

enum (Never, AfterCleanTime)

deliveryRecepientNotificationType
optional

Describes what kind of delivery recipient notifications are used in this folder.

enum (None, Immediately)

description
optional

Description of this folder.

string

enforceUniqueFilenames
optional

Indicates whether files in this folder must have unique names.

boolean

fileMaskRule
optional

Indicates whether files uploaded to the folder that match the configured filemasks will be allowed or denied.

enum (AllowExceptMatching, DenyExceptMatching)

fileMasks
optional

Comma-delimited list of filemasks which all files uploaded to the folder will be matched against.

string

folderType
optional

Indicates what kind of folder this is.

enum (Virtual, Normal, Archive, Webpost, GlobalMessaging, Mailbox, Root, RootArchives, RootWebposts)

id
optional

The unique ID of this folder.

string

isShared
optional

Indicates whether this folder is shared with someone

boolean

lastContentChangeTime
optional

Last time the folder content changed

string

name
optional

The (short) name of this folder.

string

newFileNotificationTime
optional

Describes how often new file batch notifications are sent.

integer (int32)

newFileNotificationType
optional

Describes what kind of new file notifications are used in this folder.

enum (None, Batch, Immediately)

newTime
optional

The maximum amount of time, in days, that files in this folder are considered "new".

integer (int32)

orgId
optional

ID of the organization this folder exists in.

integer (int32)

owner
optional

The username of this folder’s owner. (Home folders only)

string

parentId
optional

The ID of this folder’s parent folder or "0" if it does not have a parent folder.

string

parentInheritRights
optional

Indicates whether the folder inherits its permissions from its parent folder.

integer (int32)

path
optional

The (long) name of this folder.

string

permission
optional

A MOVEit Permission describing the currently authorized user’s permissions on this folder.

quota
optional

The folder quota, if any, in bytes.

integer (int64)

responseText
optional

For webpost folders, text to display after a post to this folder.

string

responseTime
optional

For webpost folders, the time after which redirection occurs.

integer (int32)

responseType
optional

For webpost folders, the webpost completion and redirection setting.

enum (RedirectImmediately, RedirectAfter)

subfolderCleanTime
optional

Describes after how many days empty subfolders in this folder will be cleaned up.

integer (int32)

systemType
optional

Indicates if this folder is under the control of users or the MOVEit Transfer system.

enum (User, System)

uploadNotificationConfirmationTime
optional

Describes how often batch notifications are sent.

integer (int32)

uploadNotificationConfirmationType
optional

Describes what kind of upload confirmation notifications are used in this folder.

enum (None, Batch, Immediately)

6.20. FolderPatchModel

Folder Update parameters

Name Description Schema

name
optional

New file name to set

string

6.21. FolderRequest

Name Description Schema

id
optional

Folder ID

string

6.22. FolderShareAclPermissionsModel

Name Schema

deleteFiles
optional

boolean

listFiles
optional

boolean

listUsers
optional

boolean

notify
optional

boolean

readFiles
optional

boolean

writeFiles
optional

boolean

6.23. GetFileListRequest

Name Description Schema

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Name of field to sort the results by. (name, size, datetime, uploadstamp or path); Default is Path.

string

6.24. GetFolderListRequest

Get all folders query

Name Description Schema

name
optional

File name mask for filtering list of Folders

string

page
optional

Page number to display

integer (int32)

path
optional

File path mask for filtering list of Folders

string

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Name of field to sort the results by. (Name, Type or Path); Default is Path.

string

6.25. GetGroupMemberListRequest

Name Description Schema

id
optional

Group ID

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

6.26. GetGroupsListRequest

Represents requred information in order to create a request to retreive list of groups.

Name Description Schema

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

6.27. GetMailboxListRequest

Type : object

6.28. GetSubfilesListRequest

Name Description Schema

id
optional

Parent Folder ID

string

name
optional

File Name mask to search by

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Field to sort by; Default is name.

string

6.29. GetSubfoldersListRequest

Name Description Schema

id
optional

Parent Folder ID

string

name
optional

Folder Name mask to search by

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Field to sort by; Default is name.

string

6.30. GetTransferStatusListRequest

Represents requred information in order to create a request to retreive list of XferStatus. If several filtering criteria are provided they are matched using AND logic, e.g. File Name is "abc" and userRealName is "John"

Name Description Schema

fileName
optional

Filter expression for File name

string

folderName
optional

Filter expression for Folder name

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection

integer (int32)

recentlyCompletedPeriod
optional

Time period in seconds to return recently completed data. Default: 0

integer (int32)

search
optional

Filter expression for several fields. Fields are matched with OR logic. AND logic is used if you provide expression for each particular query. Fields being matched: userLoginName, userRealName, userIp, folderName, fileName

string

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Name of field to sort the results by.

string

statusDistributionPeriod
optional

Time period in seconds to calculate status distribution for. Default: RecentlyCompletedPeriod

integer (int32)

transferStatus
optional

Filter for status. Uses OR logic

< enum (Failed, Stalled, Active, Completed) > array

userFullName
optional

Filter expression for User Display name

string

userIp
optional

Filter expression for User IP

string

userLoginName
optional

Filter expression for Login name

string

userRealName
optional

Filter expression for User Display name

string

6.31. GroupAddMemberRequest

Name Description Schema

userIds
optional

List of user ids

< string > array

6.32. GroupModel

Represents group’s requested information.

Name Description Schema

description
optional

Additional information, related to the group.

string

id
optional

Unique ID for this group.

integer (int32)

membersCount
optional

Amount of users, who are members of this particular group.

integer (int32)

name
optional

Name of the group.

string

6.33. GroupRemoveMemberRequest

Name Description Schema

id
optional

Group ID

string

userId
optional

User ID

string

6.34. IFolderPermission

Represents folder permission object

Name Description Schema

canAddSubfolders
optional
read-only

User can add subfolders to the folder.

boolean

canChangeSettings
optional
read-only

User can change the settings of the folder.

boolean

canDelete
optional
read-only

User can delete the folder.

boolean

canDeleteFiles
optional
read-only

User can delete files in the folder.

boolean

canListFiles
optional
read-only

User can list the files in the folder.

boolean

canListSubfolders
optional
read-only

User can list the subfolders of a folder.

boolean

canReadFiles
optional
read-only

User can download the files in the folder.

boolean

canShare
optional
read-only

User can share files in the folder

boolean

canWriteFiles
optional
read-only

User can upload files to the folder.

boolean

6.35. MailboxModel

Represents basic mailbox data required for all scenarios

Name Description Schema

allPackagesCount
optional

Number of all packages

integer (int32)

folderType
optional

Indicates what kind of folder this is.

enum (Virtual, Normal, Archive, Webpost, GlobalMessaging, Mailbox, Root, RootArchives, RootWebposts)

id
optional

The unique ID of this folder.

string

isShared
optional

Indicates whether this folder is shared with someone

boolean

lastContentChangeTime
optional

Last time the folder content changed

string

name
optional

The (short) name of this folder.

string

newPackagesCount
optional

Number of new packages

integer (int32)

orderIndex
optional

Mailbox order index

integer (int32)

owner
optional

Mailbox owner username

string

ownerLoginName
optional

Mailbox owner login name

string

ownerRealName
optional

Mailbox owner real name

string

parentId
optional

The ID of this folder’s parent folder or "0" if it does not have a parent folder.

string

path
optional

The (long) name of this folder.

string

relationship
optional

Mailbox relationship

integer (int32)

systemType
optional

Mailbox system type

integer (int32)

6.36. OrgInfoDto

Organization information class.

Name Description Schema

allowPassChangeRequests
optional

Organization allow password change requirement setting

boolean

baseURL
optional

Organization base URL

string

contactLink
optional

Organization contact link in default language

string

contactLinkName
optional

Organization contact link name in default language

string

formattingLocale
optional

A Locale which is used for formatting dates and times in this organization.

string

id
optional

Organization ID

string

informationLink
optional

Organization information link in default language

string

informationLinkName
optional

Organization information link name in default language

string

language
optional

Organization language

string

mobileURL
optional

Organization mobile URL

string

name
optional

Organization name

string

securityBanner
optional

Organization security banner in default language

string

securityNotice
optional

Organization security notice in default language

string

securityNoticeRequired
optional

Organization security notice requirement setting

enum (NotRequired, WhenNew, Always)

securityNoticeStamp
optional

Organization security notice change stamp

string

techEmail
optional

Organization tech support email in default language

string

techInfo
optional

Organization tech support notice in default language

string

techName
optional

Organization tech support name in default language

string

techPhone
optional

Organization tech support phone in default language

string

6.37. PackageActionRequest

Name Description Schema

action
optional

Package action (Reply, ReplyAll, Forward, Resend)

string

id
optional

Package id

string

6.38. PackageDetailsModel

Represents a package and all available attributes

Name Description Schema

attachments
optional

List of attachments

< SimpleFileModel > array

body
optional

Package body

string

deliveryReceipts
optional

Delivery receipts

boolean

dlpBlocked
optional

When true, the package contains DLP violations that prevent it from being downloaded, according to currently configured DLP rules.

boolean

dlpViolation
optional

File DLP violation info

string

expirationHours
optional

Expiration hours

integer (int32)

id
optional

Package id. The value is null for action operations

integer (int32)

isNew
optional

True if package is new

boolean

isSecureBody
optional

If true body is secured

boolean

mailboxId
optional

Mailbox id

string

maxAttachDownloads
optional

Maximum downloads of attachment

integer (int32)

noReply
optional

Used to prevent reply

enum (AllowAll, DenyReplyAll, DenyAllReplies)

parentId
optional

Parent id

string

recalled
optional

True if package is recalled

boolean

recipients
optional

List of recipients

< Recipient > array

sendStamp
optional

Mailbox time stamp

string

sender
optional

Sender info

subject
optional

Package subject

string

6.39. PackageMovePatchModel

Package Update parameters

Name Description Schema

packageId
optional

New package mailbox to set

string

6.40. PackageRecallPatchModel

Package Update parameters

Name Description Schema

recalled
optional

Set true to recall the package

boolean

6.41. PackageRequest

Name Description Schema

id
optional

Package id

string

6.42. PagedModel_FileDetailsModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

< FileDetailsModel > array

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.43. PagedModel_FolderAclEntryModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.44. PagedModel_FolderContentItemModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.45. PagedModel_GroupModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

< GroupModel > array

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.46. PagedModel_SimpleFileModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

< SimpleFileModel > array

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.47. PagedModel_SimpleFolderModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

< SimpleFolderModel > array

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.48. PagedModel_SimpleUserModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

< SimpleUserModel > array

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.49. PagedModel_UserGroupModel_

Represents paged response object with proper navigations

Name Description Schema

items
optional

Items on the given page

< UserGroupModel > array

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

6.50. PagingInfoModel

Information about paging for collection response

Name Description Schema

page
optional

Current page in collection

integer (int32)

perPage
optional

Items per page

integer (int32)

totalItems
optional

Total items in collection

integer (int64)

totalPages
optional
read-only

Total number of pages in collection

integer (int32)

6.51. Recipient

Name Description Schema

identifier
optional

Recipient identifier

string

name
optional

Recipient name (read only)

string

role
optional

Recipient role

enum (To, CC, BCC)

type
optional

Recipient type

enum (User, Group, Unreg)

6.52. RequestTokenError

Authentication failed error

Name Description Schema

error
optional

Error title

string

error_description
optional

Error details

string

6.53. RequestTokenMfaError

Authentication failed error

Name Description Schema

error
optional

Error title

string

error_description
optional

Error details

string

mfa_access_token
optional

MFA access token

string

6.54. RevokeTokenResponse

Response for Revoke token operation

Name Description Schema

message
optional

Message

string

6.55. SimpleFileModel

Container object used to provide information about a specific file on a MOVEit Transfer server.

Name Description Schema

id
optional

The unique ID of this file. Also known as the tracking number.

string

name
optional

The name of this file.

string

path
optional

The full path of this file.

string

size
optional

Size in bytes of this file.

integer (int64)

uploadStamp
optional

The date and time this file was uploaded.

string

6.56. SimpleFolderModel

Represents basic folder data required for all scenarios

Name Description Schema

folderType
optional

Indicates what kind of folder this is.

enum (Virtual, Normal, Archive, Webpost, GlobalMessaging, Mailbox, Root, RootArchives, RootWebposts)

id
optional

The unique ID of this folder.

string

isShared
optional

Indicates whether this folder is shared with someone

boolean

lastContentChangeTime
optional

Last time the folder content changed

string

name
optional

The (short) name of this folder.

string

parentId
optional

The ID of this folder’s parent folder or "0" if it does not have a parent folder.

string

path
optional

The (long) name of this folder.

string

6.57. SimplePackageModel

Represents basic package data required for all scenarios

Name Description Schema

deliveryReceipts
optional

Delivery receipts

boolean

dlpBlocked
optional

When true, the package contains DLP violations that prevent it from being downloaded, according to currently configured DLP rules.

boolean

dlpViolation
optional

File DLP violation info

string

expirationHours
optional

Expiration hours

integer (int32)

id
optional

Package id. The value is null for action operations

integer (int32)

isNew
optional

True if package is new

boolean

mailboxId
optional

Mailbox id

string

parentId
optional

Parent id

string

recalled
optional

True if package is recalled

boolean

sendStamp
optional

Mailbox time stamp

string

sender
optional

Sender info

subject
optional

Package subject

string

6.58. SimpleUserModel

Simple user model for user lists.

Name Description Schema

email
optional

User email address.

string

fullName
optional

User full name.

string

id
optional

User id.

string

lastLoginStamp
optional

Time of last user login.

string

orgID
optional

Id of organization user is a member of.

integer (int32)

permission
optional

User permission.

enum (TemporaryUser, User, FileAdmin, Admin, SysAdmin)

realname
optional

User full name.

string

status
optional

User security status.

enum (Active, Suspended, Template)

username
optional

User login name.

string

6.59. SortFieldDto

Name Schema

sortDirection
optional

enum (asc, desc)

sortField
optional

string

6.60. TokenAcquiredModel

Represents successful token request response

Name Description Schema

access_token
optional

API Token

string

expires_in
optional

Number of seconds till token expiration

integer (int32)

refresh_token
optional

Refresh token

string

token_type
optional

Type of the token

string

6.61. TransferStatusDistribution

Distribution of available statuses in collection

Name Description Schema

active
optional

Number of records in Active state

integer (int32)

completed
optional

Number of records in Succeeded state

integer (int32)

failed
optional

Number of records in Failed state

integer (int32)

lingeringTransfers
optional

Number of transfers that have recently been completed but still are displayed as in progress

integer (int32)

stalled
optional

Number of records in Stalled state

integer (int32)

6.62. TransferStatusModel

Represents active transfer information

Name Description Schema

agentBrand
optional

User agent brand

string

agentVersion
optional

User agent version

string

currentBytes
optional

Bytes already transferred

integer (int64)

direction
optional

Transfer direction

enum (Upload, Download)

errorCode
optional

Information about the transfer status, such as an error code

integer (int32)

fileId
optional

ID of the file

string

fileName
optional

File Name

string

folderId
optional

Parent Folder ID

string

folderName
optional

Parent Folder Name

string

folderPath
optional

Parent Folder Path

string

folderType
optional

Parent Folder Type

enum (Virtual, Normal, Archive, Webpost, GlobalMessaging, Mailbox, Root, RootArchives, RootWebposts)

integrityVerified
optional

Integrity Verified

boolean

moduleName
optional

Module which performs transfer

enum (Other, FTP, SSH, ISAPI, REST)

nodeNum
optional

Web Farm node number

integer (int32)

orgId
optional

ID of organization this file belongs to

integer (int32)

statusMessage
optional

Information about the transfer status, such as an error message

string

timeEnded
optional

Time when transfer ended. Null if transfer is in progress

string

timeStarted
optional

Time when transfer started

string

totalBytes
optional

Total file size, if known

integer (int64)

transferRate
optional

Rate of the transfer

integer (int64)

transferStatus
optional

Transfer status

enum (Failed, Stalled, Active, Completed)

userFullName
optional

User Real Name

string

userId
optional

ID of the user

string

userIp
optional

IP Address of user

string

userLoginName
optional

User Login Name

string

userRealName
optional

User Real Name

string

6.63. TransferStatusPagedModel

Name Description Schema

items
optional

Items on the given page

paging
optional

Paging data for given response

sorting
optional

Sorting data for given response

< SortFieldDto > array

statusDistribution
optional

Status distribution

6.64. UnprocessableEntityErrorModel

Represents an error returned by API in case of HTTP 422 error

Name Description Schema

detail
optional

An explanation specific to this occurrence of the error

string

errorCode
optional

An error number, defined by the application
Default : 0

integer (int32)

errors
optional

Detailed information about errors in provided parameters

< FieldErrorModel > array

title
optional

Short summary of the error type

string

6.65. UserDetailsModel

Detailed user model.

Name Description Schema

authMethod
optional

User authentication method; only takes effect if the organization is set to "External then MOVEit" authentication.

enum (MOVEitOnly, ExternalOnly, Both)

defaultFolderID
optional

ID of user default folder; 0 indicates the home folder is the default folder.

integer (int64)

displaySettings
optional

email
optional

User email address.

string

emailFormat
optional

Format of email notifications user receives.

enum (HTML, Text)

expirationPolicyID
optional

ID of the expiration policy configured for this user, or 0 for no policy.

integer (int32)

folderQuota
optional

User quota value, or 0 for no quota.

integer (int64)

forceChangePassword
optional

If set to 1, user must change their password on their next login.

boolean

fullName
optional

User full name.

string

homeFolderID
optional

ID of user home folder, or 0 for no home folder.

integer (int64)

id
optional

User id.

string

language
optional

User language code.

string

lastLoginStamp
optional

Time of last user login.

string

notes
optional

User description.

string

orgID
optional

Id of organization user is a member of.

integer (int32)

passwordChangeStamp
optional

Time of last user password change.

string

permission
optional

User permission.

enum (TemporaryUser, User, FileAdmin, Admin, SysAdmin)

realname
optional

User full name.

string

receivesNotification
optional

User email notifications setting.

enum (ReceivesNoNotifications, ReceivesNotifications, AdminReceivesNotifications)

status
optional

User security status.

enum (Active, Suspended, Template)

statusNote
optional

User security status description.

string

username
optional

User login name.

string

6.66. UserGroupModel

Represents a group that a specific user is a member of, including the relationship that user has with the group.

Name Description Schema

description
optional

Additional information, related to the group.

string

id
optional

Unique ID for this group.

integer (int32)

name
optional

Name of the group.

string

relationship
optional

User Group relationship

enum (Member, GroupAdmin)

6.67. UserGroupsRequest

User list query.

Name Description Schema

id
optional

User Id.

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

6.68. UserListRequest

User list query.

Name Description Schema

email
optional

User email

string

fullName
optional

User real name

string

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

permission
optional

User permission filter.

enum (AllUsers, EndUsers, Administrators, FileAdmins, GroupAdmins, TemporaryUsers, SysAdmins)

realname
optional

User real name

string

sortDirection
optional

Sort direction; Default is ascending.

string

sortField
optional

Name of field to sort the results by. (username, realname, lastLoginStamp or email); Default is username.

string

status
optional

User status filter.

enum (AllUsers, ActiveUsers, InactiveUsers, NeverSignedOnUsers, TemplateUsers)

username
optional

User name

string

6.69. UserPatchModel

Contains the user properties that should change

Name Description Schema

authMethod
optional

Auth method type

enum (MOVEitOnly, ExternalOnly, Both)

defaultFolderId
optional

Default folder Id

integer (int64)

email
optional

Email address

string

emailFormat
optional

Email format type

enum (HTML, Text)

folderQuota
optional

User quota

integer (int64)

forceChangePassword
optional

Force password change

boolean

fullName
optional

Real name of user

string

language
optional

Language

string

notes
optional

Notes

string

password
optional

User password

string

permission
optional

User permission type

enum (TemporaryUser, User, FileAdmin, Admin, SysAdmin)

realName
optional

Real name of user

string

receivesNotification
optional

Notification type

enum (ReceivesNoNotifications, ReceivesNotifications, AdminReceivesNotifications)

status
optional

User status type

enum (Active, Suspended, Template)

statusNote
optional

User status note

string

6.70. UserRequest

Name Description Schema

id
optional

User ID

string