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/).
This REST Endpoint Provides These Resources

1.

/api/v1/token

Get/renew a session token using MOVEit Transfer user credentials.

2.

/api/v1/users /api/v1/groups

User and group management actions, roles, home folders, and other properties.

3.

/api/v1/folders

Folders, folder actions, folder contents and folder properties.

4.

/api/v1/files

File management actions and file properties.

5.

/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 2018 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,
	"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. 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.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. Retrieve API token

POST /api/V1/token

5.1.1. Parameters

Type Name Description Schema

FormData

grant_type
required

Type of authentication used

enum (password, refresh_token)

FormData

language
optional

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

string

FormData

orgId
optional

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

string

FormData

password
optional

User password. Use with "password" grant_type

string

FormData

refresh_token
optional

Refresh token. Use with "refresh_token" grant_type

string

FormData

username
optional

User name. Use with "password" grant_type

string

5.1.2. Responses

HTTP Code Schema

200

400

5.1.3. Consumes

  • application/x-www-form-urlencoded

5.1.4. Tags

  • Authentication

5.2. Revokes API token

POST /api/V1/token/revoke

5.2.1. Parameters

Type Name Description Schema

FormData

token
required

Access token or Refresh token to revoke

string

5.2.2. Responses

HTTP Code Schema

200

401

5.2.3. Consumes

  • application/x-www-form-urlencoded

5.2.4. Tags

  • Authentication

5.3. Get list of files current user can view

GET /api/v1/files

5.3.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.3.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.3.3. Produces

  • application/json

  • text/json

5.3.4. Tags

  • Files

5.3.5. Security

Type Name

Unknown

apiKey

5.4. Return file details

GET /api/v1/files/{Id}

5.4.1. Parameters

Type Name Description Schema

Path

Id
required

File ID

string

5.4.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.4.3. Produces

  • application/json

  • text/json

5.4.4. Tags

  • Files

5.4.5. Security

Type Name

Unknown

apiKey

5.5. Delete file

DELETE /api/v1/files/{Id}

5.5.1. Parameters

Type Name Description Schema

Path

Id
required

File ID

string

5.5.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.5.3. Produces

  • application/json

  • text/json

5.5.4. Tags

  • Files

5.5.5. Security

Type Name

Unknown

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

No Content

403

Forbidden

500

Server Error

5.6.3. Produces

  • application/octet-stream

5.6.4. Tags

  • Files

5.6.5. Security

Type Name

Unknown

apiKey

5.7. Partial file update

PATCH /api/v1/files/{fileId}

5.7.1. Parameters

Type Name Description Schema

Path

fileId
required

ID of the file to update

string

Body

body
required

File Update parameters

5.7.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.7.3. Consumes

  • application/json

  • text/json

5.7.4. Produces

  • application/json

  • text/json

5.7.5. Tags

  • Files

5.7.6. Security

Type Name

Unknown

apiKey

5.8. Copy file into another folder

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

5.8.1. Parameters

Type Name Description Schema

Path

Id
required

ID of the file to copy

integer (int32)

Body

body
required

File copy request details

5.8.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

404

Resource Not Found

409

Operation Conflicted

500

Server Error

5.8.3. Consumes

  • application/json

  • text/json

5.8.4. Produces

  • application/json

  • text/json

5.8.5. Tags

  • Files

5.8.6. Security

Type Name

Unknown

apiKey

5.9. Get list of folders current user can view

GET /api/v1/folders

5.9.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.9.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.9.3. Produces

  • application/json

  • text/json

5.9.4. Tags

  • Folders

5.9.5. Security

Type Name

Unknown

apiKey

5.10. Return folder details

GET /api/v1/folders/{Id}

5.10.1. Parameters

Type Name Description Schema

Path

Id
required

Folder ID

string

5.10.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.10.3. Produces

  • application/json

  • text/json

5.10.4. Tags

  • Folders

5.10.5. Security

Type Name

Unknown

apiKey

5.11. Delete folder

DELETE /api/v1/folders/{Id}

5.11.1. Parameters

Type Name Description Schema

Path

Id
required

Folder ID

string

5.11.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.11.3. Produces

  • application/json

  • text/json

5.11.4. Tags

  • Folders

5.11.5. Security

Type Name

Unknown

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

Unknown

apiKey

5.13. Get content of the folder

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

5.13.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; Default is name.

string

5.13.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.13.3. Produces

  • application/json

  • text/json

5.13.4. Tags

  • FolderContent

5.13.5. Security

Type Name

Unknown

apiKey

5.14. Upload file into folder

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

5.14.1. Description

The content type of the request must be "multipart/form-data".

5.14.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.14.3. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.14.4. Consumes

  • multipart/form-data

5.14.5. Produces

  • application/json

  • text/json

5.14.6. Tags

  • FolderContent

5.14.7. Security

Type Name

Unknown

apiKey

5.15. Get list of files in folder

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

5.15.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.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

Unknown

apiKey

5.16. Get list of subfolders in folder

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

5.16.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.16.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.16.3. Produces

  • application/json

  • text/json

5.16.4. Tags

  • FolderContent

5.16.5. Security

Type Name

Unknown

apiKey

5.17. Partial Folder update

PATCH /api/v1/folders/{folderId}

5.17.1. Parameters

Type Name Description Schema

Path

folderId
required

ID of the folder to update

integer (int32)

Body

body
required

Folder Update parameters

5.17.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.17.3. Consumes

  • application/json

  • text/json

5.17.4. Produces

  • application/json

  • text/json

5.17.5. Tags

  • Folders

5.17.6. Security

Type Name

Unknown

apiKey

5.18. Set the Access Controls for a given folder

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

5.18.1. Parameters

Type Name Description Schema

Path

folderId
required

ID of the folder to set access control

integer (int32)

Body

body
required

Access control

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

  • Folders

5.18.6. Security

Type Name

Unknown

apiKey

5.19. Delete the Access Controls for a given folder

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

5.19.1. Parameters

Type Name Description Schema

Path

folderId
required

ID of the folder to delete access control

integer (int32)

Body

body
required

Entity type and id

5.19.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.19.3. Consumes

  • application/json

  • text/json

5.19.4. Produces

  • application/json

  • text/json

5.19.5. Tags

  • Folders

5.19.6. Security

Type Name

Unknown

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

integer (int32)

Path

folderId
required

Parent folder ID

integer (int32)

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

Unknown

apiKey

5.21. Download file. Redirect

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

5.21.1. Parameters

Type Name Description Schema

Path

fileId
required

File ID

integer (int32)

Path

folderId
required

Parent folder ID

integer (int32)

5.21.2. Responses

HTTP Code Description Schema

302

Redirect

No Content

403

Forbidden

500

Server Error

5.21.3. Produces

  • application/json

  • text/json

5.21.4. Tags

  • FolderContent

5.21.5. Security

Type Name

Unknown

apiKey

5.22. Create new subfolder in folder

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

5.22.1. Parameters

Type Name Description Schema

Path

parentFolderId
required

ID of the folder where new folder should be added

integer (int32)

Body

body
required

5.22.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.22.3. Consumes

  • application/json

  • text/json

5.22.4. Produces

  • application/json

  • text/json

5.22.5. Tags

  • FolderContent

5.22.6. Security

Type Name

Unknown

apiKey

5.23. Get subfolder details. Redirect

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

5.23.1. Parameters

Type Name Description Schema

Path

parentId
required

Parent folder ID

integer (int32)

Path

subfolderId
required

Folder ID to Get

integer (int32)

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

Unknown

apiKey

5.24. Delete subfolder. Redirect

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

5.24.1. Parameters

Type Name Description Schema

Path

parentId
required

Parent folder ID

integer (int32)

Path

subfolderId
required

Folder ID to Delete

integer (int32)

5.24.2. Responses

HTTP Code Description Schema

302

Redirect

No Content

403

Forbidden

500

Server Error

5.24.3. Produces

  • application/json

  • text/json

5.24.4. Tags

  • FolderContent

5.24.5. Security

Type Name

Unknown

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

5.25.3. Produces

  • application/json

  • text/json

5.25.4. Tags

  • Groups

5.25.5. Security

Type Name

Unknown

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

5.26.3. Produces

  • application/json

  • text/json

5.26.4. Tags

  • Groups

5.26.5. Security

Type Name

Unknown

apiKey

5.27. Gets information about organization

GET /api/v1/info

5.27.1. Parameters

Type Name Description Schema Default

Query

orgId
optional

Organization ID

string

""

5.27.2. Responses

HTTP Code Description Schema

200

OK

500

Server Error

5.27.3. Produces

  • application/json

  • text/json

5.27.4. Tags

  • OrganizationInfo

5.27.5. Security

Type Name

Unknown

apiKey

5.28. Create new user

POST /api/v1/users

5.28.1. Description

If SourceUserId specified in user model clone operation will be executed

5.28.2. Parameters

Type Name Schema

Body

body
required

5.28.3. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.28.4. Consumes

  • application/json

  • text/json

5.28.5. Produces

  • application/json

  • text/json

5.28.6. Tags

  • Users

5.28.7. Security

Type Name

Unknown

apiKey

5.29. Get list of users

GET /api/v1/users

5.29.1. Parameters

Type Name Description Schema

Query

email
optional

User email

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.29.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.29.3. Produces

  • application/json

  • text/json

5.29.4. Tags

  • Users

5.29.5. Security

Type Name

Unknown

apiKey

5.30. Get current user details

GET /api/v1/users/self

5.30.1. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.30.2. Produces

  • application/json

  • text/json

5.30.3. Tags

  • Users

5.30.4. Security

Type Name

Unknown

apiKey

5.31. Get user details

GET /api/v1/users/{Id}

5.31.1. Parameters

Type Name Description Schema

Path

Id
required

User ID

string

5.31.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.31.3. Produces

  • application/json

  • text/json

5.31.4. Tags

  • Users

5.31.5. Security

Type Name

Unknown

apiKey

5.32. Delete user

DELETE /api/v1/users/{Id}

5.32.1. Parameters

Type Name Description Schema

Path

Id
required

User ID

string

5.32.2. Responses

HTTP Code Description Schema

204

No Content

403

Forbidden

500

Server Error

5.32.3. Produces

  • application/json

  • text/json

5.32.4. Tags

  • Users

5.32.5. Security

Type Name

Unknown

apiKey

5.33. Get list of user groups

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

5.33.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.33.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.33.3. Produces

  • application/json

  • text/json

5.33.4. Tags

  • Users

5.33.5. Security

Type Name

Unknown

apiKey

5.34. Partial user update

PATCH /api/v1/users/{id}

5.34.1. Parameters

Type Name Description Schema

Path

Id
required

ID of user to update

string

Body

body
required

Contains the user properties that should change

5.34.2. Responses

HTTP Code Description Schema

200

OK

403

Forbidden

500

Server Error

5.34.3. Consumes

  • application/json

  • text/json

5.34.4. Produces

  • application/json

  • text/json

5.34.5. Tags

  • Users

5.34.6. Security

Type Name

Unknown

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

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. 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.4. 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.5. FileCopyRequest

File copy request details

Name Description Schema

destinationFolderId
optional

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

integer (int32)

6.6. 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)

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 (date-time)

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.7. FilePatchModel

File Update parameters

Name Description Schema

name
optional

New file name to set

string

6.8. FileRequest

Name Description Schema

id
optional

File ID

string

6.9. 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.10. 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

writeFiles
optional

boolean

6.11. FolderAclsRequest

Name Description Schema

id
optional

Folder ID

integer (int32)

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.12. 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, 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 (date-time)

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.13. FolderContentSqlRequest

Name Description Schema

id
optional

Parent Folder ID

integer (int32)

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; Default is name.

string

6.14. 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, 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 (date-time)

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.15. FolderPatchModel

Folder Update parameters

Name Description Schema

name
optional

New file nime to set

string

6.16. FolderRequest

Name Description Schema

id
optional

Folder ID

integer (int32)

6.17. 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.18. 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.19. GetGroupMemberListRequest

Name Description Schema

id
optional

Group ID

integer (int64)

page
optional

Page number to display

integer (int32)

perPage
optional

Items per page in result collection; Default is 25

integer (int32)

6.20. 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.21. GetSubfilesListRequest

Name Description Schema

id
optional

Parent Folder ID

integer (int32)

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.22. GetSubfoldersListRequest

Name Description Schema

id
optional

Parent Folder ID

integer (int32)

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.23. GroupModel

Represents group’s requested information.

Name Description Schema

description
optional

Addidional 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.24. 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

canWriteFiles
optional
read-only

User can upload files to the folder.

boolean

6.25. 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

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 (date-time)

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.26. 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.27. 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.28. 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.29. 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.30. 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.31. 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.32. 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.33. 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.34. RequestTokenError

Authentication failed error

Name Description Schema

error
optional

Error title

string

error_description
optional

Error details

string

6.35. RevokeTokenResponse

Response for Revoke token operation

Name Description Schema

message
optional

Message

string

6.36. 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 (date-time)

6.37. 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, 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 (date-time)

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.38. SimpleUserModel

Simple user model for user lists.

Name Description Schema

email
optional

User email address.

string

id
optional

User id.

string

lastLoginStamp
optional

Time of last user login.

string (date-time)

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.39. SortFieldDto

Name Schema

sortDirection
optional

enum (asc, desc)

sortField
optional

string

6.40. TokenAcquiredModel

Represents succesful 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.41. 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)

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

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 (date-time)

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 (date-time)

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.42. 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.43. UserListRequest

User list query.

Name Description Schema

email
optional

User email

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.44. 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

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.45. UserRequest

Name Description Schema

id
optional

User ID

string