1. Overview
MOVEit Automation provides a set of RESTful APIs (application programming interfaces) to allow users to access resources on a MOVEit Automation server. These APIs can be used to integrate MOVEit Automation with other applications, automate creation of MOVEit Automation resources (such as hosts or tasks), or create custom user interfaces.
RESTful APIs are accessed via http/s and do not require installing any additional packages on the client machine making them more flexible than COM or Java based APIs.
|
Tip
|
The REST API is mapped to run at https://<your-webadmin-server>/swagger-ui/ Where <your-webadmin-server> is the hostname or IP address of the MOVEit Automation Web Admin. |
The following resources are available through the MOVEit Automation REST API:
| Resource | Description |
|---|---|
Request or refresh an authorization token. |
|
Get MOVEit Automation application information. |
|
Download or upload an unencrypted copy of the MOVEit Automation config.xml file. |
|
List all custom scripts or get a specified custom script. |
|
List all date lists or get a specified date list. |
|
List global parameters or get a specified global parameter. |
|
List or get a host. |
|
List all PGP keys or get a specified PGP key. |
|
Generate or export reports for tasks runs, file activity, or audit logs. |
|
List or get a Resource Group. List or get an ACL. Add, delete, or update an existing ACL. |
|
List all SSH keys or get a specified SSH key. |
|
List all SSL certs or get a specified SSL cert. |
|
List all standard scripts or get a specified standard script. |
|
|
List task groups or get a specified task group. |
Delete a task, list tasks, list running tasks, get the task scheduler status (2020.1, or later), get a task, add a new task, update an existing task, start or stop a task, and start or stop the scheduler. List all task logs or get a specified task log. |
|
List or get a User Group. |
|
Live Swagger UI interactive documentation. |
2. Getting Started
You can call the MOVEit Automation APIs using a variety of tools or programming languages. This documentation provides an overview of using curl or swagger to create and execute APIs.
2.1. Pre-requisites
Before you begin using the MOVEit Automation RESTful API, you must install the MOVEit Automation Web Admin server. APIs are only available through the Web Admin server.
To use the REST APIs, you need the following information:
-
The hostname or IP address of the Web Admin server
-
The username and password for an authorized account on MOVEit Automation server
2.2. REST API using the cURL command-line utility
This section provides an example of using the REST API and the cURL command line utility to authenticate with MOVEit Automation and retrieve the list of tasks.
|
Tip
|
When issuing requests against a non-production host running a self-signed SSL certificate, use curls -k option to bypass SSL verification.
|
2.2.1. Request an access token
To use the MOVEit Automation RESTful API you must request an access token. The access token is used in subsequent API calls for authorization.
To request a token, enter the curl POST command:
curl -X POST "https://<your-webadmin-server>/api/v1/token" -H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=password&username=<username>&password=<password>"Where
-
<your-webadmin-server> is the hostname or IP address of the MOVEit Automation Web Admin.
-
<username> is the username of the account with which you want to log on
-
<password> is the account password
Example Output
{
"access_token": "eyJh…..8VOY",
"token_type": "bearer",
"expires_in": 900,
"refresh_token": "eyJh…..H0NY"
}2.2.2. Example: List tasks
To get a list of tasks, run the GET method on the api/v1/tasks resource using the authorization token.
curl -X GET "https://<your-webadmin-server>/api/v1/tasks" -H "accept: application/json" -H "Authorization: Bearer <access_token>"Where
-
<your-webadmin-server> is the hostname or IP address of the Web Admin server
-
<access_token> is the value that was returned when you requested an access token.
Example Output
{
"paging": {
"page": 1,
"perPage": 2147483647,
"totalItems": 125,
"totalPages": 1
},
"sorting": [
{
"sortField": "Name",
"sortDirection": "asc"
}
],
"items": [
{
"Group": [],
"ID": "226676691",
"Name": "!TaylorImportTest",
"Renamed": false,
"Info": {
"Description": "\n\t\t\t\t",
"Notes": "\n\t\t\t\t"
},
"steps": [
{
"Process": {
"Parameters": {
"Certs_Password": {
"value": "",
"DisplayValue": "(suppressed)"
}
},
"Run": "PerFile",
"ScriptID": "104001",
"IsDest": 0,
"ID": "23"
}
},
{
"Process": {
"Run": "PerFile",
"ScriptID": "100402",
"IsDest": 0,
"ID": "11"
}
}
],
"Active": 0,
"AR": 0,
"CacheNames": "random",
"NextEID": 12,
"TT": "",
"UseDefStateCaching": 1
}
]
}2.2.3. Example: Run a task
To run a task run, enter the curl POST command:
curl -X POST "https://<your-webadmin-server>/api/v1/tasks/<taskId>/start" -H "accept: application/json" -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d "{ \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\"}"Where
-
<your-webadmin-server> is the hostname or IP address of the Web Admin server
-
<taskId> is the ID of a task
-
<access_token> is the value that was returned when you requested an access token.
Example Output
{
"nominalStart": "2018-03-13 12:21:43.92"
}2.3. REST API using Swagger interactive documentation
To interact with MOVEit Automation via a RESTful interface, access the interactive documentation that is included with the MOVEit Automation Web Admin.
The documentation specifies the available resources in the REST API and the operations that the API client can call. The documentation also specifies the list of operation parameters, including the parameter name and type, information about the parameter values and whether the parameters are optional or required.
2.3.1. Accessing the Swagger interactive documentation for the REST API
Interactive documentation for the REST API is available at the following URL:
https://<your-webadmin-server>/swagger-ui/Where <your-webadmin-server> is the value that was provided when MOVEit Automation Web Admin was installed on your system.
2.3.2. Accessing the API Authorization Token
To access and execute any REST API that is defined in the interactive documentation, you must request an authorization token using your MOVEit Automation Server login details or a valid refresh token.
-
Select Authorization Token API in the Select a spec list.
-
Click Authorization Token > POST /api/v1/token.
-
Click Try it out.
-
Enter the following:
-
grant_typeis "password" -
server_host(If the server_host value is not specified, the first configured MOVEit Automation server is used.) -
username -
password
-
-
Click Execute.
The call returns an access and a refresh token. Make note of the access and refresh tokens to access the application REST API.
2.3.3. Applying the REST API Authorization Token
To use the API for performing operations on MOVEit Automation server, you must enter a valid Authorization Token.
-
Select MOVEit Automation REST API in the Select a spec list.
-
Click Authorize.
-
In the Value field of the Available authorizations window enter the following:
Bearer <access_token>
Where
<access_token>is the value that was returned when you called the Authorization Token API. -
Click Authorize > Done.
The authorization token is sent with each request.
Note: The default expiry times for the access token and refresh token are 5 and 15 minutes respectively. To continue executing calls after the expiry time, you must get a new access token using the Authorization Token API.
3. Progress Software Corporation MOVEit Automation - Authorization Token API
team@openapitools.org V1 :toc: left :numbered: :toclevels: 3 :source-highlighter: highlightjs :keywords: openapi, rest, Progress Software Corporation MOVEit Automation - Authorization Token API :specDir: false :snippetDir: false :generator-template: v1 2019-12-20 :info-url: https://openapi-generator.tech :app-name: Progress Software Corporation MOVEit Automation - Authorization Token API
3.1. Introduction
This API is used to get, refresh or revoke an authorization token. The authorization token is then used in MOVEit Automation REST API calls to validate the user access.
3.2. Endpoints
3.2.1. AuthorizationToken
requestAuthTokenUsingPOST
POST /api/v1/token
Request or refresh an authorization token
Description
Use this call to request a new authorization token or refresh an authorization token. To request a new authorization token, enter the following content. * grant_type is password * server_host * username * password If the server_host value is not specified, the first configured MOVEit Automation server is used. The call returns an authorization token that contains an access token and a refresh token in the Response body. The default expiry times for the access token and refresh token are 5 and 15 minutes respectively. To refresh a token, enter the following content. * grant_type is refresh_token * refresh_token is <refresh_token_value> The call returns new access and refresh tokens. Make note of the access and refresh tokens to access the application REST API. No additional authentication is required for this call. The request content type is \"application/x-www-form-urlencoded\".
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Samples
revokeTokenUsingPOST
POST /api/v1/token/revoke
Revoke an authorization token
Description
Use this call to revoke an access or refresh token. Revoking a token that is expired or already revoked succeeds without errors. To enhance security, revoke tokens when the API client is finished using them. No additional authentication is required for this call. The request content type is \"application/x-www-form-urlencoded\".
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
token |
- |
null |
Return Type
-
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
<<>> |
400 |
Bad Request |
|
500 |
Internal Server Error |
Samples
3.3. Models
Authorization Token Authorization Token
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
access_token |
String |
Token used for accessing the application REST API |
||
expires_in |
Long |
The lifetime in seconds of the access token |
int64 |
|
refresh_token |
String |
Token used for obtaining a new authorization token. Cannot be used to access the application REST API directly. |
||
token_type |
String |
Type of the access token, case-insensitive. Only "bearer" is supported currently. |
Authorization token error Authorization token error
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
error |
X |
String |
Error code |
|
error_description |
X |
String |
Description of the error with additional information |
Server Error Message Server Error Message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
detail |
X |
String |
An explanation specific to this occurrence of the error |
|
errorCode |
Integer |
The error code returned from the server |
int32 |
|
status |
X |
Integer |
The HTTP status code generated by the origin server for this occurrence of the error |
int32 |
title |
X |
String |
A short summary of the error type |
4. Progress Software Corporation MOVEit Automation - REST API
team@openapitools.org V1 :toc: left :numbered: :toclevels: 3 :source-highlighter: highlightjs :keywords: openapi, rest, Progress Software Corporation MOVEit Automation - REST API :specDir: false :snippetDir: false :generator-template: v1 2019-12-20 :info-url: https://openapi-generator.tech :app-name: Progress Software Corporation MOVEit Automation - REST API
4.1. Introduction
The MOVEit Automation REST API accesses resources on the MOVEit Automation Server
4.2. Access
-
APIKey KeyParamName: Authorization, KeyInQuery: false, KeyInHeader: true
4.3. Endpoints
4.3.1. AboutInfo
getInfoUsingGET
GET /api/v1/info
Get MOVEit Automation application information
Description
This call gets the MOVEit Automation Web Admin and Server version, licensing, and time zone information. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
500 |
Internal Server Error |
Samples
4.3.2. Config
exportConfigUsingGET
GET /api/v1/config
Download an unencrypted copy of the MOVEit Automation config.xml file
Description
This call exports a copy of the MOVEit Automation config.xml file. The response content type is \"application/xml\" for 200 response code and \"application/json\" for all other cases. Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
<<>> |
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
importConfigUsingPUT
PUT /api/v1/config
Upload an unencrypted copy of the MOVEit Automation config.xml file
Description
This call imports a copy of the MOVEit Automation config.xml file. Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
xmlConfig |
The configuration xml file to import [string] |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
No Content |
<<>> |
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
409 |
Conflict |
<<>> |
422 |
Invalid Input |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
4.3.3. CustomScripts
getCustomScriptUsingGET
GET /api/v1/customscripts/{customScriptId}
Get a custom script
Description
This call gets the custom script that is specified by the custom script ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customScriptId |
The Custom Script ID |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listCustomScriptsUsingGET
GET /api/v1/customscripts
List all custom scripts
Description
This call gets a list of custom scripts based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.4. DateLists
getDateListUsingGET
GET /api/v1/datelists/{dateListId}
Get a date list
Description
This call gets the date list that is specified by the date list ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
dateListId |
The Date List ID |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listDateListsUsingGET
GET /api/v1/datelists
List all date lists
Description
This call gets a list of date lists based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.5. GlobalParameters
getGlobalParameterUsingGET
GET /api/v1/globalparameters/{name}
Get global parameter
Description
This call gets a single global parameter that is specified by the case-sensitive global parameter name. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
name |
The Global Parameter Name |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listGlobalParametersUsingGET
GET /api/v1/globalparameters
List global parameters
Description
This call gets a list of global parameters based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.6. Hosts
getHostUsingGET
GET /api/v1/hosts/{hostId}
Get a host
Description
This call gets a single host that is specified by the host ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
hostId |
The Host ID |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listHostsUsingGET
GET /api/v1/hosts
List hosts
Description
This call gets a list of hosts based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
|
type |
A single case-sensitive host type with which to filter. The valid types are FileSystem, FTP, POP3, Share, siLock, SMTP, SSHFTP, AS1, AS2, AS3, and S3. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.7. PGPKeys
getPGPKeyUsingGET
GET /api/v1/pgpkeys/{pgpKeyId}
Get a PGP key
Description
This call gets the PGP key that is specified by the PGP key ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
pgpKeyId |
The PGP Key ID |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listPGPKeysUsingGET
GET /api/v1/pgpkeys
List all PGP keys
Description
This call gets a list of PGP keys based on the request parameters and the current user's permissions. By default the results are sorted by ID in ascending order. When the \"uid\" parameter is specified, the call returns a list of matching uids. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
|
uid |
The search uid (used instead of name for PGP keys). The uid is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.8. Reports
exportReportUsingPOST
POST /api/v1/reports/export
Export an Audit, File Activity or Task Runs report
Description
This call exports a report based on the input values and the current user's permissions. The language used to define the **predicate** in the report query is summarized as follows. **Logical operators** (lowercase and case-sensitive): * AND operator: `;` or `and` * OR operator: `,` or `or` By default, the AND operator is evaluated before any OR operators. To change the precedence, use a parenthesized expression to yield the contained expression. A comparison consists of a case-insensitive column name, an argument (a single value or comma-separated multiple values in parenthesis), and a comparison operator. Columns are defined in the report record of the response model. **Comparison operators:** * Equal to: `==` * Not equal to: `!=` * Less than: `=lt=` or `<` * Less than or equal to: `=le=` or `<=` * Greater than operator: `=gt=` or `>` * Greater than or equal to: `=ge=` or `>=` * In: `=in=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=in=(Task1,Task2)` * Not in: `=out=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=out=(Task1,Task2)` * Like: `=like=` **NOTE**: Use percent sign (`%`) as multiple-character wildcard, and underscore (`_`) as single-character wildcard; prefix with backslash (`\\`) to escape `%` or `_` A string value must be single (`'`) or double-quoted (`\"`) unless it does not contain any reserved characters or spaces. The reserved characters are `\"`, `'`, `(`, `)`, `;`, `,`, `=`, `!`, `~`, `<`, `>`. To use both single and double quotes inside a quoted argument, you must escape one of them using a backslash `(\\)`. If you use the backslash `(\\)` reserved character, you must double the backslash `(\\\\)`. Backslash only has a special meaning inside a quoted argument. **Predicate examples:** * `taskname==Task1` * `TaskName=like=%task%` * `TaskID=in=(12345,67891);logstamp>\"2018-01-01T12:00:00\"` A sample JSON input that queries status is either `Success` or `Failure`, and task name contains `hello\"%_\\world`, with special characters escaped properly. ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like=\\\"%hello\\\\\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%\\\"\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` or use single quote for predicate, ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like='%hello\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%'\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` The report result sorting order is specified by the **orderBy** input field with comma-separated case-insensitive column names. The column name can be prefixed with `!` for descending order. **Examples:** * `taskname` * `TaskID,!LogStamp` To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Report export criteria |
The report export criteria [Report Export Criteria] |
X |
Return Type
Content Type
-
/
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
409 |
Conflict |
<<>> |
422 |
Invalid Input |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
getAuditReportUsingPOST
POST /api/v1/reports/audit
Generate an Audit report
Description
This call generates an audit log report based on the input values and the current user's permissions. To get the same result as from the Web Admin UI, use the predicate `predicate='Status==\"Failure\"'` and orderBy `!LogTime` in the input. The language used to define the **predicate** in the report query is summarized as follows. **Logical operators** (lowercase and case-sensitive): * AND operator: `;` or `and` * OR operator: `,` or `or` By default, the AND operator is evaluated before any OR operators. To change the precedence, use a parenthesized expression to yield the contained expression. A comparison consists of a case-insensitive column name, an argument (a single value or comma-separated multiple values in parenthesis), and a comparison operator. Columns are defined in the report record of the response model. **Comparison operators:** * Equal to: `==` * Not equal to: `!=` * Less than: `=lt=` or `<` * Less than or equal to: `=le=` or `<=` * Greater than operator: `=gt=` or `>` * Greater than or equal to: `=ge=` or `>=` * In: `=in=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=in=(Task1,Task2)` * Not in: `=out=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=out=(Task1,Task2)` * Like: `=like=` **NOTE**: Use percent sign (`%`) as multiple-character wildcard, and underscore (`_`) as single-character wildcard; prefix with backslash (`\\`) to escape `%` or `_` A string value must be single (`'`) or double-quoted (`\"`) unless it does not contain any reserved characters or spaces. The reserved characters are `\"`, `'`, `(`, `)`, `;`, `,`, `=`, `!`, `~`, `<`, `>`. To use both single and double quotes inside a quoted argument, you must escape one of them using a backslash `(\\)`. If you use the backslash `(\\)` reserved character, you must double the backslash `(\\\\)`. Backslash only has a special meaning inside a quoted argument. **Predicate examples:** * `taskname==Task1` * `TaskName=like=%task%` * `TaskID=in=(12345,67891);logstamp>\"2018-01-01T12:00:00\"` A sample JSON input that queries status is either `Success` or `Failure`, and task name contains `hello\"%_\\world`, with special characters escaped properly. ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like=\\\"%hello\\\\\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%\\\"\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` or use single quote for predicate, ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like='%hello\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%'\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` The report result sorting order is specified by the **orderBy** input field with comma-separated case-insensitive column names. The column name can be prefixed with `!` for descending order. **Examples:** * `taskname` * `TaskID,!LogStamp` To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Query input |
The report query input [Report Query Input] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
getFileActivityReportUsingPOST
POST /api/v1/reports/fileactivity
Generate a File Activity report
Description
This call generates a report for file activities based on the input values and the current user's permissions. To get the same result as from the Web Admin UI, use the predicate `StatusCode=out=(\"5000\",\"5010\")` and orderBy `!LogStamp` in the input. The language used to define the **predicate** in the report query is summarized as follows. **Logical operators** (lowercase and case-sensitive): * AND operator: `;` or `and` * OR operator: `,` or `or` By default, the AND operator is evaluated before any OR operators. To change the precedence, use a parenthesized expression to yield the contained expression. A comparison consists of a case-insensitive column name, an argument (a single value or comma-separated multiple values in parenthesis), and a comparison operator. Columns are defined in the report record of the response model. **Comparison operators:** * Equal to: `==` * Not equal to: `!=` * Less than: `=lt=` or `<` * Less than or equal to: `=le=` or `<=` * Greater than operator: `=gt=` or `>` * Greater than or equal to: `=ge=` or `>=` * In: `=in=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=in=(Task1,Task2)` * Not in: `=out=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=out=(Task1,Task2)` * Like: `=like=` **NOTE**: Use percent sign (`%`) as multiple-character wildcard, and underscore (`_`) as single-character wildcard; prefix with backslash (`\\`) to escape `%` or `_` A string value must be single (`'`) or double-quoted (`\"`) unless it does not contain any reserved characters or spaces. The reserved characters are `\"`, `'`, `(`, `)`, `;`, `,`, `=`, `!`, `~`, `<`, `>`. To use both single and double quotes inside a quoted argument, you must escape one of them using a backslash `(\\)`. If you use the backslash `(\\)` reserved character, you must double the backslash `(\\\\)`. Backslash only has a special meaning inside a quoted argument. **Predicate examples:** * `taskname==Task1` * `TaskName=like=%task%` * `TaskID=in=(12345,67891);logstamp>\"2018-01-01T12:00:00\"` A sample JSON input that queries status is either `Success` or `Failure`, and task name contains `hello\"%_\\world`, with special characters escaped properly. ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like=\\\"%hello\\\\\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%\\\"\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` or use single quote for predicate, ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like='%hello\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%'\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` The report result sorting order is specified by the **orderBy** input field with comma-separated case-insensitive column names. The column name can be prefixed with `!` for descending order. **Examples:** * `taskname` * `TaskID,!LogStamp` To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Query input |
The report query input [Report Query Input] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
getTaskRunsReportUsingPOST
POST /api/v1/reports/taskruns
Generate a Task Runs report
Description
This call generates a report for task run history based on the input values and the current user's permissions. To get the same result as from the Web Admin UI, use the predicate `Status=in=(\"Success\",\"Failure\")` and orderBy `!StartTime` in the input. The language used to define the **predicate** in the report query is summarized as follows. **Logical operators** (lowercase and case-sensitive): * AND operator: `;` or `and` * OR operator: `,` or `or` By default, the AND operator is evaluated before any OR operators. To change the precedence, use a parenthesized expression to yield the contained expression. A comparison consists of a case-insensitive column name, an argument (a single value or comma-separated multiple values in parenthesis), and a comparison operator. Columns are defined in the report record of the response model. **Comparison operators:** * Equal to: `==` * Not equal to: `!=` * Less than: `=lt=` or `<` * Less than or equal to: `=le=` or `<=` * Greater than operator: `=gt=` or `>` * Greater than or equal to: `=ge=` or `>=` * In: `=in=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=in=(Task1,Task2)` * Not in: `=out=` **NOTE**: Requires brackets and at least two elements in the group, example: `TaskName=out=(Task1,Task2)` * Like: `=like=` **NOTE**: Use percent sign (`%`) as multiple-character wildcard, and underscore (`_`) as single-character wildcard; prefix with backslash (`\\`) to escape `%` or `_` A string value must be single (`'`) or double-quoted (`\"`) unless it does not contain any reserved characters or spaces. The reserved characters are `\"`, `'`, `(`, `)`, `;`, `,`, `=`, `!`, `~`, `<`, `>`. To use both single and double quotes inside a quoted argument, you must escape one of them using a backslash `(\\)`. If you use the backslash `(\\)` reserved character, you must double the backslash `(\\\\)`. Backslash only has a special meaning inside a quoted argument. **Predicate examples:** * `taskname==Task1` * `TaskName=like=%task%` * `TaskID=in=(12345,67891);logstamp>\"2018-01-01T12:00:00\"` A sample JSON input that queries status is either `Success` or `Failure`, and task name contains `hello\"%_\\world`, with special characters escaped properly. ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like=\\\"%hello\\\\\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%\\\"\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` or use single quote for predicate, ```json { \"predicate\": \"Status=in=(\\\"Success\\\",\\\"Failure\\\");TaskName=like='%hello\\\"\\\\\\\\%\\\\\\\\_\\\\\\\\world%'\", \"orderBy\": \"!StartTime\", \"maxCount\": 100 } ``` The report result sorting order is specified by the **orderBy** input field with comma-separated case-insensitive column names. The column name can be prefixed with `!` for descending order. **Examples:** * `taskname` * `TaskID,!LogStamp` To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
Query input |
The report query input [Report Query Input] |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.9. ResourceGroups
addACLUsingPOST
POST /api/v1/resourcegroups/acls
Add a new ACL
Description
This call adds a new access control list (ACL). To create an ACL, enter the new ACL details or use an existing ACL as a template. To use an existing ACL as a template, complete the following steps. 1. Call an existing ACL using a GET call. 2. Copy the ACL details into a POST call to create a new ACL. 3. Edit the ACL parameters as required. The new ACL is created with a unique ACLID. Default values are applied to unspecified ACL fields. By default, all ACLs have view permissions for all resources. The TaskEditExisting permission cannot be disabled if the TaskAddEditDelete permission is enabled. The following sample content is for a new ACL: ```json { \"UserGroupName\": \"TEST-DOMAIN\\\\MOVEit Users-Group test\", \"ResourceGroupName\": \"Rest resource group\", \"Permissions\": { \"TaskRun\": 0, \"TaskEditExisting\": 0, \"TaskAddEditDelete\": 0, \"HostAddEditDelete\": 0, \"PGPAddEditDelete\": 0, \"SSHAddEditDelete\": 0, \"SSLAddEditDelete\": 0, \"ScriptAddEditDelete\": 0 } } ``` Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
acl |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
deleteACLUsingDELETE
DELETE /api/v1/resourcegroups/acls/{aclId}
Delete an ACL
Description
This call deletes a single ACL specified by the ACLID. Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
aclId |
The ACL ID |
X |
null |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
No Content |
<<>> |
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
getACLUsingGET
GET /api/v1/resourcegroups/acls/{aclId}
Get access control list
Description
This call gets the ACL that is specified by the acl id. Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
aclId |
The ACL ID |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
getResourceGroupUsingGET
GET /api/v1/resourcegroups/{resourceGroupName}
Get a resource group
Description
This call gets the resource group that is specified by the resource group name. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
resourceGroupName |
The Resource Group Name |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listACLsUsingGET
GET /api/v1/resourcegroups/acls
List access control lists
Description
This call gets a list of ACLs based on the request parameters. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"userGroupName\" parameter is specified, the call returns a list of ACLs matching user group name. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` When the \"resourceGroupName\" parameter is specified, the call returns a list of ACLs matching a resource group name. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
|
resourceGroupName |
The name of the resource group to search for. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
userGroupName |
The name of the user group to search for. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
listResourceGroupsUsingGET
GET /api/v1/resourcegroups
List resource groups
Description
This call gets a list of resource groups based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
updateACLUsingPUT
PUT /api/v1/resourcegroups/acls/{aclId}
Update existing ACL
Description
This call updates existing ACL. To update the ACL, the ACLID, UserGroupName and ResourceGroupName in the request must match the ACLID, UserGroupName and ResourceGroupName in the ACL, or they can be skipped from the request. The TaskEditExisting permission cannot be disabled if the TaskAddEditDelete permission is enabled. Update applying only on the specified fields, skipped fields stay unmodified. Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
aclId |
The ACL ID |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
acl |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.10. SSHKeys
getSshKeyUsingGET
GET /api/v1/sshkeys/{sshKeyId}
Get SSH key
Description
This call gets a single SSH key that is specified by the SSH key ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
sshKeyId |
The SSH Key ID |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listSSHKeysUsingGET
GET /api/v1/sshkeys
List all SSH keys
Description
This call gets a list of SSH keys based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.11. SSLCertificates
getSSLCertificateUsingGET
GET /api/v1/sslcerts/{sslCertificateThumbprint}
Get SSL Certificate
Description
This call gets a single SSL certificate that is specified by the SSL cert thumbprint. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
sslCertificateThumbprint |
The SSL Certificate Thumbprint |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listSSLCertsUsingGET
GET /api/v1/sslcerts
List all SSL Certificates
Description
This call gets a list of ssl certificates based on the request parameters and the current user's permissions. By default, the results are sorted by issuer in ascending order, regardless of whether the \"issuer\" parameter is specified in the request parameters, and is not case-sensitive. When the \"issuer\" parameter is specified, the call returns a list of certificates with matching issuers. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
issuer |
The search issuer (used instead of name for SSL certificates). The issuer is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.12. StandardScripts
getStandardScriptUsingGET
GET /api/v1/standardscripts/{standardScriptId}
Get a standard script
Description
This call gets the standard script that is specified by the standard script ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
standardScriptId |
The Standard Script ID |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listStandardScriptsUsingGET
GET /api/v1/standardscripts
List all standard scripts
Description
This call gets a list of standard scripts based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.13. TaskGroups
getTaskGroupUsingGET
GET /api/v1/taskgroups/{taskGroupName}
Get a task group (Deprecated. Use Resource Groups API)
Description
This call gets the task group that is specified by the task group name. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskGroupName |
The Task Group Name |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listTaskGroupsUsingGET
GET /api/v1/taskgroups
List task groups (Deprecated. Use Resource Groups API)
Description
This call gets a list of task groups based on the request parameters and the current user's permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.14. Tasks
addTaskUsingPOST
POST /api/v1/tasks
Add a new task
Description
This call adds a new traditional task. To create a traditional task you can enter the relevant new task details or use an existing task as a template. To use an existing task as a template complete the following steps. 1. Call an existing task using a GET call. 2. Copy the task details into a POST call to create a new task. 3. Edit the task parameters as required. The new task will be created with a unique ID. Default values are applied to blank task fields. The validity of dependant configuration items, including hosts, scripts, date lists, and other tasks are checked. The following is a sample input for a new traditional task: ```json { \"Info\": { \"Description\": \"This is a sample task that moves a file from one folder to another at 1:00AM on every Monday.\", \"Notes\": \"Please use this only as a simple template for adding a new task.\" }, \"Schedules\": { \"Schedule\": [ { \"Days\": { \"DayOfWeek\": [ \"Monday\" ] }, \"Frequency\": { \"Interval\": [ { \"StartTime\": \"01:00\", \"EndTime\": \"01:00\" } ] } } ] }, \"steps\": [ { \"Source\": { \"HostID\": \"0\", \"Path\": \"C:\\\\Logs\", \"Type\": \"FileSystem\", \"DeleteOrig\": 1, \"DelRename\": 1, \"FileMask\": \"sample.log\" } }, { \"Process\": { \"Run\": \"PerFile\", \"ScriptID\": \"100401\" } }, { \"Destination\": { \"HostID\": \"0\", \"Path\": \"C:\\\\TargetLogs\", \"Type\": \"FileSystem\", \"FileName\": \"[OrigName]\", \"OverwriteOrig\": 1 } } ], \"Name\": \"Sample Task\", \"Active\": 0 } ``` Non-admin users must specify the task group(s) to which the new config item should be added. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
task |
Task Task Task |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
deleteTaskUsingDELETE
DELETE /api/v1/tasks/{taskId}
Delete a task
Description
This call deletes a single task specified by the task ID. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskId |
Task ID |
X |
null |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
No Content |
<<>> |
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
getSchedulerStatusUsingGET
GET /api/v1/tasks/scheduler
Get scheduler status
Description
This call returns the scheduler status. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
Return Type
Content Type
-
/
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
getTaskLogUsingGET
GET /api/v1/tasks/{taskId}/log/{taskLogId}
Get a task log
Description
This call gets a single task log that is specified by task log ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskId |
Task ID |
X |
null |
|
taskLogId |
The Task Log ID |
X |
null |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
<<>> |
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
404 |
Not Found |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
getTaskUsingGET
GET /api/v1/tasks/{taskId}
Get a task
Description
This call gets a single task that is specified by task ID. If the resource does not exist or the user is not permitted to access the resource, the call returns a 404 error. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskId |
The Task ID |
X |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listRunningTasksUsingGET
GET /api/v1/tasks/running
List running tasks
Description
This call lists running tasks based on the request parameters and the current user's permissions. By default, the results are sorted by name, regardless of whether the \"name\" parameter is specified in the request parameters, and nominal start in ascending order and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Comma-separated, case-sensitive top-level Task field names. Invalid field names will be ignored |
- |
null |
|
name |
The case-insensitive task search name. |
- |
null |
|
page |
Page number (from 1) |
- |
null |
|
perPage |
Number of tasks per page |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
listTaskLogsUsingGET
GET /api/v1/tasks/{taskId}/log
List task logs
Description
This call lists the task logs relevant to the specified task ID. You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskId |
Task ID |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Comma-separated, case-sensitive top-level Task field names. Invalid field names will be ignored |
- |
null |
|
page |
Page number (from 1) |
- |
null |
|
perPage |
Number of tasks per page |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
500 |
Internal Server Error |
Samples
listTasksUsingGET
GET /api/v1/tasks
List tasks
Description
This call gets a list of tasks based on the request parameters and the current userâs permissions. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
startStopSchedulerUsingPUT
PUT /api/v1/tasks/scheduler/{startStop}
Start/Stop scheduler
Description
This call enables or disables the task scheduler. Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
startStop |
Valid values are "start" or "stop". |
X |
null |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
No Content |
<<>> |
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
409 |
Conflict |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
startTaskUsingPOST
POST /api/v1/tasks/{taskId}/start
Start a task
Description
This call starts a task. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskId |
The Task ID |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
params |
The optional parameters consist of name value pairs posted in the request body. [string] |
- |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
stopTaskUsingPOST
POST /api/v1/tasks/{taskId}/stop
Stop a task
Description
This call stops a running task. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskId |
The Task ID |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
nominalStart |
The nominal start time of the task. It must be in the format yyyy-MM-dd hh:mm:ss.SS. [Stop Task Input] |
X |
Return Type
-
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
<<>> |
400 |
Bad Request |
<<>> |
401 |
Authentication Error |
<<>> |
403 |
Authorization Error |
<<>> |
404 |
Not Found |
<<>> |
409 |
Conflict |
<<>> |
422 |
Invalid Input |
<<>> |
500 |
Internal Server Error |
<<>> |
Samples
updateTaskUsingPUT
PUT /api/v1/tasks/{taskId}
Update an existing task
Description
This call updates an existing traditional task. To update an existing task, 1. Call the task that you want to update using a GET call. 2. Edit the task parameters as required. 3. Use the edited task details as the request body for this call. The value of `ID` field in the request body will be replaced by the task ID provided in the URL path when they are different. Default values are applied to null task fields. The validity of dependant configuration items, including hosts, scripts, date lists, and other tasks are checked. Please note that not all APIs are available now for listing the above config items, you can get their IDs from the Web Admin UI instead. For example, to locate the ID for a script, open the script in the Web Admin UI, **SCRIPTS** > **<script_name>** > **General** > **ID**. Value for `Group` field in the request will be ignored. Groups of a task cannot be changed after the task is created. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
taskId |
The Task ID |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
task |
Task Task Task |
X |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.3.15. UserGroups
getUserGroupUsingGET
GET /api/v1/usergroups/{userGroupName}
Get user group
Description
This call gets a single user group that is specified by the case-sensitive user group name. Parameter 'type' defines if a user group is local or remote. Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
userGroupName |
The User Group Name |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
type |
Search user groups by type. The types are 'local' or 'remote'. If the parameter is not specified, by default 'local' user groups are listed. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
404 |
Not Found |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
listUserGroupsUsingGET
GET /api/v1/usergroups
List user groups
Description
This call gets a list of user groups based on the request parameters. By default, the results are sorted by name in ascending order, regardless of whether the \"name\" parameter is specified in the request parameters, and is not case-sensitive. When the \"name\" parameter is specified, the call returns a list of matching names. The results are not case-sensitive. The matching rules are described below. * `text - Exact match` * `* - All` * `** - All` * `* text * - Contains \"text\"` * `text * - Starts with \"text\"` * `* text - Ends with \"text\"` You can specify which top-level fields to include by entering a list of comma-separated case-sensitive field names in the \"fields\" parameter. Available field names are listed in the model of the resource. Pagination information is provided for browsing the result. The following are the valid value combinations. Invalid combinations return a 422 error. | page | perPage | response | | --- | --- | --- | | | | All objects in the result set, up to *2 147 483 647* objects | | Positive | Positive | Objects on the specified page of the result set | | | Positive | Objects on the first page of the result set, with given page size | | Positive | | Objects on a specified page of the result set, with default page size | Access to this API is restricted to users that belong to the âMOVEit Adminâ Windows user group. To use the API to perform operations on the MOVEit Automation server, you must enter a valid Authorization Token in the following format. ``` Authorization: Bearer <access_token> ``` The authorization token is sent with each request.
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fields |
Top-level, comma-separated case-sensitive field names. Invalid field names are ignored. |
- |
null |
|
name |
The search name. The name is case-insensitive. The wildcard character `*` can be used at the start or end of the search parameter. |
- |
null |
|
page |
Page number (start at page 1). |
- |
null |
|
perPage |
Number of items per page. |
- |
null |
|
type |
Search user groups by type. The types are 'local' or 'remote'. If the parameter is not specified, by default 'local' user groups are listed. |
- |
null |
Return Type
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
OK |
Object[[object]] |
400 |
Bad Request |
|
401 |
Authentication Error |
|
403 |
Authorization Error |
|
409 |
Conflict |
|
422 |
Invalid Input |
|
500 |
Internal Server Error |
Samples
4.4. Models
4.4.1. _ _
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
C |
String |
Comment |
||
Date |
String |
Date in the format yyyy-mm-dd |
AS1 Host AS1 Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ClientCertSHA1 |
String |
Client certificate SHA1 |
||
ClientCertStore |
String |
Client certificate store |
||
ClientCertSubject |
String |
Client certificate subject |
||
DecryptCertSHA1 |
String |
Decryption certificate SHA1 |
||
DecryptCertStore |
String |
Decryption certificate store |
||
DecryptCertSubject |
String |
Decryption certificate subject |
||
DefCompressionFormat |
String |
Default compression format |
Enum: None, ZLib, |
|
DefEDIDataType |
String |
Default EDI data type |
Enum: application/edi-consent, application/edi-x12, application/edifact, application/octet-stream, application/xml, |
|
DefEncryptionAlgorithm |
String |
Default encryption algorithm |
Enum: 3DES, AES, AESCBC192, AESCBC256, DES, None, RC2, |
|
DefPartnerCertSHA1 |
String |
Default partner certificate SHA1 |
||
DefPartnerCertStore |
String |
Default partner certificate store |
||
DefPartnerCertSubject |
String |
Default partner certificate subject |
||
DefPartnerName |
String |
Default partner name |
||
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefSignatureAlgorithm |
String |
Default signature algorithm |
Enum: md5, sha-224, sha-256, sha-384, sha-512, sha1, |
|
DefSigningCertSHA1 |
String |
Default signing certificate SHA1 |
||
DefSigningCertStore |
String |
Default signing certificate store |
||
DefSigningCertSubject |
String |
Default signing certificate subject |
||
DeleteIfNewerThanDays |
Integer |
Delete if newer than days |
int32 |
|
DeleteIfOlderThanDays |
Integer |
Delete if older than days |
int32 |
|
Desc |
String |
Description |
||
FIPSOnly |
String |
Whether to use FIPS only |
Enum: 0, 1, |
|
FirewallHostIP |
String |
Firewall host IP |
||
FirewallPassword |
String |
Firewall password |
||
FirewallPort |
Integer |
Firewall port |
int32 |
|
FirewallType |
String |
Firewall type |
Enum: EMPTY, SOCKS4, SOCKS5, Tunnel, |
|
FirewallUsername |
String |
Firewall username |
||
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
IgnoreCertProbs |
String |
Ingnore certificate problems |
Enum: 0, 1, |
|
MDNPollCount |
Integer |
MDN polling count |
int32 |
|
MDNPollTimeoutSecs |
Integer |
MDN polling timeout value in seconds |
int32 |
|
Name |
String |
Name of the object |
||
OrgName |
String |
Organization name |
||
POPPort |
Integer |
POP port |
int32 |
|
POPServer |
String |
POP server |
||
Password |
String |
Password |
||
PauseRerunSecs |
Integer |
Pause rerun seconds |
int32 |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
SMTPAuthMethod |
String |
SMTP authentication method |
Enum: Auth, CRAM-MD5, None, |
|
SMTPPassword |
String |
SMTP password |
||
SMTPPort |
Integer |
SMTP port |
int32 |
|
SMTPServer |
String |
SMTP server |
||
SMTPUsername |
String |
SMTP username |
||
SSLStartMode |
String |
SSL start mode |
Enum: Explicit, Implicit, None, |
|
UseSMTPInfo |
String |
Use SMTP information |
Enum: 0, 1, |
|
UseSigningCertForDecrypt |
String |
Whether to use signing certificate for decryption |
Enum: 0, 1, |
|
Username |
String |
Username |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
AS2 Host AS2 Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AS1HostID |
String |
AS1 host ID |
||
ClientCertSHA1 |
String |
Client certificate SHA1 |
||
ClientCertStore |
String |
Client certificate store |
||
ClientCertSubject |
String |
Client certificate subject |
||
DMZHostID |
String |
DMZ host ID |
||
DecryptCertSHA1 |
String |
Decryption certificate SHA1 |
||
DecryptCertStore |
String |
Decryption certificate store |
||
DecryptCertSubject |
String |
Decryption certificate subject |
||
DefCompressionFormat |
String |
Default compression format |
Enum: None, ZLib, |
|
DefEDIDataType |
String |
Default EDI data type |
Enum: application/edi-consent, application/edi-x12, application/edifact, application/octet-stream, application/xml, |
|
DefEncryptionAlgorithm |
String |
Default encryption algorithm |
Enum: 3DES, AES, AESCBC192, AESCBC256, DES, None, RC2, |
|
DefPartnerCertSHA1 |
String |
Default partner certificate SHA1 |
||
DefPartnerCertStore |
String |
Default partner certificate store |
||
DefPartnerCertSubject |
String |
Default partner certificate subject |
||
DefPartnerName |
String |
Default partner name |
||
DefPartnerURL |
String |
Partner URL |
||
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefSignatureAlgorithm |
String |
Default signature algorithm |
Enum: md5, sha-224, sha-256, sha-384, sha-512, sha1, |
|
DefSigningCertSHA1 |
String |
Default signing certificate SHA1 |
||
DefSigningCertStore |
String |
Default signing certificate store |
||
DefSigningCertSubject |
String |
Default signing certificate subject |
||
Desc |
String |
Description |
||
FIPSOnly |
String |
Whether to use FIPS only |
Enum: 0, 1, |
|
FirewallHostIP |
String |
Firewall host IP |
||
FirewallPassword |
String |
Firewall password |
||
FirewallPort |
Integer |
Firewall port |
int32 |
|
FirewallType |
String |
Firewall type |
Enum: EMPTY, SOCKS4, SOCKS5, Tunnel, |
|
FirewallUsername |
String |
Firewall username |
||
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
IgnoreCertProbs |
String |
Ignore certificate problems |
Enum: 0, 1, |
|
MDNPollCount |
Integer |
MDN polling count |
int32 |
|
MDNPollTimeoutSecs |
Integer |
MDN polling timeout value in seconds |
int32 |
|
MailFrom |
String |
Mail from |
||
Name |
String |
Name of the object |
||
OrgName |
String |
Organization name |
||
Password |
String |
Password |
||
ProxyPassword |
String |
Proxy password |
||
ProxyPort |
Integer |
Proxy port |
int32 |
|
ProxySSL |
String |
Proxy SSL |
Enum: Always, Auto, Never, Tunnel, |
|
ProxyServer |
String |
Proxy server |
||
ProxyServerType |
String |
Proxy server type |
Enum: Default, None, Specific, |
|
ProxyUsername |
String |
Proxy username |
||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
SMTPServer |
String |
SMTP server |
||
UseHTTPAuth |
String |
Use HTTP authentication |
Enum: 0, 1, |
|
UseSigningCertForDecrypt |
String |
Whether to use signing certificate for decryption |
Enum: 0, 1, |
|
Username |
String |
Username |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
AS3 Host AS3 Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ClientCertSHA1 |
String |
Client certificate SHA1 |
||
ClientCertStore |
String |
Client certificate store |
||
ClientCertSubject |
String |
Client certificate subject |
||
DecryptCertSHA1 |
String |
Decryption certificate SHA1 |
||
DecryptCertStore |
String |
Decryption certificate store |
||
DecryptCertSubject |
String |
Decryption certificate subject |
||
DefCompressionFormat |
String |
Default compression format |
Enum: None, ZLib, |
|
DefEDIDataType |
String |
Default EDI data type |
Enum: application/edi-consent, application/edi-x12, application/edifact, application/octet-stream, application/xml, |
|
DefEncryptionAlgorithm |
String |
Default encryption algorithm |
Enum: 3DES, AES, AESCBC192, AESCBC256, DES, None, RC2, |
|
DefPartnerCertSHA1 |
String |
Default partner certificate SHA1 |
||
DefPartnerCertStore |
String |
Default partner certificate store |
||
DefPartnerCertSubject |
String |
Default partner certificate subject |
||
DefPartnerName |
String |
Default partner name |
||
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefSignatureAlgorithm |
String |
Default signature algorithm |
Enum: md5, sha-224, sha-256, sha-384, sha-512, sha1, |
|
DefSigningCertSHA1 |
String |
Default signing certificate SHA1 |
||
DefSigningCertStore |
String |
Default signing certificate store |
||
DefSigningCertSubject |
String |
Default signing certificate subject |
||
Desc |
String |
Description |
||
FIPSOnly |
String |
Whether to use FIPS only |
Enum: 0, 1, |
|
FirewallHostIP |
String |
Firewall host IP |
||
FirewallPassword |
String |
Firewall password |
||
FirewallPort |
Integer |
Firewall port |
int32 |
|
FirewallType |
String |
Firewall type |
Enum: EMPTY, SOCKS4, SOCKS5, Tunnel, |
|
FirewallUsername |
String |
Firewall username |
||
Group |
List of [string] |
Groups the object belongs to |
||
Host |
String |
Host |
||
ID |
String |
ID of the object |
||
IgnoreCertProbs |
String |
Ignore certificate problems |
Enum: 0, 1, |
|
MDNPollCount |
Integer |
MDN polling count |
int32 |
|
MDNPollTimeoutSecs |
Integer |
MDN polling timeout value in seconds |
int32 |
|
Name |
String |
Name of the object |
||
OrgName |
String |
Organization name |
||
Passive |
String |
Passive |
Enum: 0, 1, |
|
Password |
String |
Password |
||
PauseRerunSecs |
Integer |
Pause rerun seconds |
int32 |
|
Port |
Integer |
Port |
int32 |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
Secure |
String |
How to encrypt the connection |
Enum: Explicit, Implicit, None, |
|
UseSigningCertForDecrypt |
String |
Whether to use signing certificate for decryption |
Enum: 0, 1, |
|
Username |
String |
Username |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
About Info About Info
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
appBuildNumber |
String |
MOVEit Automation Web Admin build number |
||
appBuildTimestamp |
String |
MOVEit Automation Web Admin build timestamp |
||
appVersion |
String |
MOVEit Automation Web Admin version |
||
centralApiVersion |
String |
MOVEit Automation server API version |
||
centralHost |
String |
MOVEit Automation server host |
||
centralVersion |
String |
MOVEit Automation server version |
||
domain |
String |
Domain |
||
featuresEnabled |
List of [Features Enabled] |
Information about the enabled features |
||
isAdmin |
Boolean |
Authenticated as admin |
||
license |
License |
|||
maxInactiveSessionInterval |
Integer |
Maximum interval for an inactive session |
int32 |
|
serverCertificateDaysValid |
Long |
Remaining days the server certificate is valid for |
int64 |
|
serverTimezoneInfo |
Server Timezone Info |
|||
username |
String |
Username |
Access Control List Access Control List
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ACLID |
String |
ACL Id |
||
Permissions |
Permissions |
|||
ResourceGroupName |
String |
Resource Group Name |
||
UserGroupName |
String |
User Group Name |
Access Control List Result Access Control List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Access Control List] |
List of ACLs |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
And Type And Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comp |
X |
List of [Comp Type] |
comp |
Audit Report Audit Report
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Audit Report Record] |
List of audit log records |
|
sorting |
List of [Sorting Field] |
Sorting information |
Audit Report Record Audit Report Record
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Action |
String |
Action |
||
AgentBrand |
String |
Agent brand |
||
AgentVersion |
String |
Agent version |
||
CentralVersion |
String |
Central version |
||
ClientIP |
String |
Client IP address |
||
Hash |
String |
Hash |
||
IPAddress |
String |
IP address |
||
LogID |
Integer |
Log ID |
int32 |
|
LogTime |
Date |
Log time |
date-time |
|
Node |
Integer |
Node |
int32 |
|
QueryType |
String |
Query type |
||
Status |
String |
Status |
||
StatusCode |
Integer |
Status code |
int32 |
|
StatusMsg |
String |
Status message |
||
TargetID |
String |
Target ID |
||
TargetType |
String |
Target type |
||
TaskName |
String |
Task name |
||
Username |
String |
Username |
4.4.2. Choices Choices
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Choice |
List of [string] |
List of choices |
Comp Type Comp Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
a |
X |
String |
Lefthand operand |
|
b |
X |
String |
Righthand operand |
|
test |
X |
String |
The comparison to make. Valid values are: NGT for numeric greater than, NLT for numeric less than, NGE for numeric greater than or equal to, NLE for numeric less than or equal to, NEQ for numeric equals, NNE for numeric not equal to, DGT for date greater than, DLT for date less than, DGE for date greater than or equal to, DLE for date less than or equal to, DEQ for date equals, DNE for date not equal to, MASK for filename matches mask, NOTMASK for filename does not match mask |
Enum: DGT, DLT, MASK, NEQ, NGE, NGT, NLE, NLT, NNE, NOTMASK, |
Criteria Type Criteria Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
And |
And Type |
|||
Or |
Or Type |
|||
comp |
Comp Type |
Custom Script Custom Script
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Description |
String |
Description |
||
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
Lang |
String |
Script language |
Enum: PS1, VBScript, |
|
Name |
String |
Name of the object |
||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
Source |
String |
Source |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Custom Script List Result Custom Script List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Custom Script] |
List of custom scripts |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
Date List Date List
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Description |
String |
Description |
||
Entries |
List of << >> |
Array of single element json objects containing either {"C": "Comment Value"} or {"Date": "yyyy-mm-dd"} |
||
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
Name |
String |
Name of the object |
||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Date List Reference Date List Reference
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ID |
String |
ID of the date list |
||
Run |
X |
String |
Whether to run |
Enum: 0, 1, |
value |
String |
Value |
Date List, List Result Date List, List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Date List] |
List of date lists |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
4.4.3. Days Days
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
DayOfMonth |
List of [integer] |
Days of month |
int32 |
|
DayOfWeek |
List of [string] |
Days of week |
Enum: |
Destination Step Destination Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AB |
String |
ASCII vs binary transfer mode; applies only to FTP |
Enum: ascii, binary, |
|
Account |
String |
The account to use during authentication; for FTP only. Rarely used. |
||
AddCom |
String |
Commands to execute (per file) before transfer; applies only to FTP |
||
AddComAX |
String |
Commands to execute (per file) after transfer; applies only to FTP |
||
AddressTo |
String |
Email address for SMTP destinations |
||
BlindDL |
String |
Blind download enabled: if enabled, no directory listing is done prior to download |
Enum: 0, 1, |
|
BlindUL |
String |
Whether to do blind upload |
Enum: 0, 1, |
|
Bucket |
String |
S3 bucket name; for AWS S3 only |
||
ClientCertSHA1 |
String |
Client certificate SHA1 |
||
ClientCertStore |
String |
Client certificate store |
||
ClientCertSubject |
String |
Client certificate subject |
||
ClientKeyID |
String |
Client key ID |
||
ConnTimeoutSecs |
Integer |
Connection timeout seconds |
int32 |
|
DataTimeoutSecs |
Integer |
Data timeout in seconds |
int32 |
|
DestFileAttr |
String |
Destination file attribute |
||
FileName |
String |
Destination filename |
||
FolderID |
String |
MOVEit Transfer folder ID |
||
FolderName |
String |
Folder name |
||
FolderType |
String |
Folder type; rarely-used setting that applies only to MOVEit Transfer hosts |
Enum: -1, 1, 10, 110, 119, 19, 4, 99, |
|
ForceDir |
String |
Force directory if it does not already exist |
Enum: 0, 1, |
|
HostID |
String |
ID of associated host |
||
ID |
String |
ID |
||
IsHTML |
String |
Indicate email format HTML vs plain text |
Enum: 0, 1, |
|
MD5File |
String |
Filename of the MD5SUM file; used only by FTP and SFTP |
||
MD5Get |
String |
Whether to process MD5SUM files |
Enum: IfPresent, Never, Required, |
|
MDNEmail |
String |
MDN email recipient, for AS/1 destinations |
||
MDNFileMaskToPoll |
String |
MDN file mask to poll |
||
MDNPath |
String |
Path of the Message Disposition Notification; used only by AS/x |
||
MDNURL |
String |
URL to which the AS/x MDN should be sent |
||
MailSubject |
String |
AS/x email subject |
||
Message |
String |
The body of the email message to send |
||
MultipleAttachments |
String |
Whether an AS/x destination should attach multiple files to a single message |
Enum: 0, 1, |
|
MxBy |
Long |
Maximum number of bytes per task run |
int64 |
|
MxFi |
Integer |
Maximum number of files per task run |
int32 |
|
OverwriteOrig |
String |
What to do if the destination filename already exists |
Enum: 0, 1, 2, |
|
Passive |
String |
Whether to use passive mode; used only by FTP |
Enum: 0, 1, |
|
Password |
String |
Password |
||
Path |
String |
Folder path of the source or destination |
||
RequestAsyncMDN |
String |
Whether to request an async MDN |
Enum: 0, 1, |
|
RequestMDN |
String |
Whether an MDN should be requested |
Enum: 0, 1, |
|
RequestSigned |
String |
Whether request should be signed |
Enum: 0, 1, |
|
RescanSecs |
Integer |
Rescan in seconds |
int32 |
|
RetryCount |
Integer |
Retry count |
int32 |
|
RetryIfNoFiles |
String |
Whether to rescan for files if none were found |
Enum: 0, 1, |
|
RetryTimeoutSecs |
Integer |
Retry timeout in seconds |
int32 |
|
ReuseSSL |
String |
Whether to reuse SSL sessions; for FTP only |
Enum: 0, 1, |
|
Rsm |
Integer |
Whether to attempt resume of transfers; 0 means no and 1 means yes |
int32 |
|
SearchSubdirs |
String |
Whether to search subdirectories |
Enum: 0, 1, |
|
SetFileAttr |
String |
Whether to set file attributes after upload, if UseDefSetFileAttr is false |
Enum: 0, 1, |
|
Sort |
String |
Desired sorting of files from a MOVEit Transfer host. Allowed values are "Name,N", "Size,N", or "Date,N" where N=A or D, for Ascending and Descending |
Enum: Date,A, Date,D, Filename,A, Filename,D, Size,A, Size,D, |
|
Subject |
String |
Email subject |
||
Type |
String |
The host type of this step |
Enum: AS1, AS2, AS3, AzureBlob, FTP, FileSystem, POP3, S3, SMTP, SSHFTP, Share, SharePoint, siLock, |
|
UDMxBy |
String |
Use the host's default maximum bytes |
Enum: 0, 1, |
|
UDMxFi |
String |
Use the host's default maximum files |
Enum: 0, 1, |
|
UseDefAB |
String |
Use the host's default ASCII vs binary; applies only to FTP |
Enum: 0, 1, |
|
UseDefBlindDL |
String |
Use the host's default blind download setting |
Enum: 0, 1, |
|
UseDefBlindUL |
String |
Use default blind upload |
Enum: 0, 1, |
|
UseDefBucket |
String |
Whether to use the host's default bucket; for S3 only |
Enum: 0, 1, |
|
UseDefClientCert |
String |
Use the host's default client certificate |
Enum: 0, 1, |
|
UseDefClientKey |
String |
Use the host's default client key |
Enum: 0, 1, |
|
UseDefConnTimeoutSecs |
String |
Use the host's default connection timeout in seconds |
Enum: 0, 1, |
|
UseDefDataTimeoutSecs |
String |
Use the host's default data timeout in seconds |
Enum: 0, 1, |
|
UseDefMD5File |
String |
Use the host's default MD5 file |
Enum: 0, 1, |
|
UseDefMD5Get |
String |
Use the host's default setting for whether to process MD5SUM files |
Enum: 0, 1, |
|
UseDefPartner |
String |
Use default partner |
Enum: 0, 1, |
|
UseDefPassive |
String |
Use the host's default passive |
Enum: 0, 1, |
|
UseDefRescanSecs |
String |
Use the host's default rescan seconds |
Enum: 0, 1, |
|
UseDefRetryCount |
String |
Use the host's default retry count |
Enum: 0, 1, |
|
UseDefRetryTimeoutSecs |
String |
Use the host's default retry timeout in seconds |
Enum: 0, 1, |
|
UseDefReuseSSL |
String |
Use the host's default reuse SSL; for FTP only |
Enum: 0, 1, |
|
UseDefRsm |
String |
Use the host's default resume of file transfers |
Enum: 0, 1, |
|
UseDefSetFileAttr |
String |
Use the host's default set file attribute |
Enum: 0, 1, |
|
UseDefSort |
String |
Use the host's default sort |
Enum: 0, 1, |
|
UseDefUser |
String |
Use the host's default user |
Enum: 0, 1, |
|
UseDefWinCopyFileAPI |
String |
Use the host's default Windows copy file API setting |
Enum: 0, 1, |
|
UseDefXS |
String |
Use the host's default setting whether to check integrity via XSHA1. For FTP only. |
Enum: 0, 1, |
|
UseEncryptionCert |
String |
Whether an encryption certificate should be used |
Enum: 0, 1, |
|
UseOrigName |
String |
Use original filename on destination |
Enum: 0, 1, |
|
UseRelativeSubdirs |
String |
Use relative subdirectories |
Enum: 0, 1, |
|
UseWinCopyFileAPI |
String |
Which file copy algorithm to use for UNC hosts. A value of 0 means use the Windows API function CopyFileEx, which is generally faster. This is the recommended setting. A value of 1 means use a read/write loop. |
Enum: 0, 1, |
|
Username |
String |
Username |
||
VerificationCertSHA1 |
String |
Verification certificate SHA1 |
||
VerificationCertStore |
String |
Verification certificate store |
||
VerificationCertSubject |
String |
Verification certificate subject |
||
XS |
String |
Whether to use XSHA1 for integrity checking. For FTP only. A value of 0 means do not use XSHA1; a value of 1 means do use XSHA1. |
||
Zip |
String |
Whether to zip the file |
Enum: 0, 1, |
Email Step Email Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AddressTo |
String |
Email address |
||
HostID |
String |
ID of the SMTP host |
||
ID |
String |
ID |
||
IsHTML |
String |
Indicate email format HTML vs plain text |
Enum: 0, 1, |
|
Message |
String |
Body of the email to send |
||
Subject |
String |
Subject of the email to send |
||
Type |
String |
This setting is not used |
||
UseDefConnTimeoutSecs |
String |
Use default connection timeout in seconds |
Enum: 0, 1, |
|
UseDefDataTimeoutSecs |
String |
Use default data timeout in seconds |
Enum: 0, 1, |
|
UseDefRetryCount |
String |
Use default retry count |
Enum: 0, 1, |
|
UseDefRetryTimeoutSecs |
String |
Use default retry timeout in seconds |
Enum: 0, 1, |
Error Message Error Message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
detail |
X |
String |
An explanation specific to this occurrence of the error |
|
status |
X |
Integer |
The HTTP status code generated by the origin server for this occurrence of the error |
int32 |
title |
X |
String |
A short summary of the error type |
FTP Host FTP Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AddCom |
String |
Commands to execute (per file) before transfer |
||
AddComAX |
String |
Commands to execute (per file) after transfer |
||
AddComSignon |
String |
Commands to execute upon signon |
||
AdjDST |
String |
Account for daylight savings |
Enum: 0, 1, |
|
AuthOrder |
String |
Authentication order |
||
CustomDir |
String |
Custom directory parsing enabled |
Enum: 0, 1, |
|
CustomDirColDate |
Integer |
Custom directory column for date |
int32 |
|
CustomDirColFilename |
Integer |
Custom directory column for filename |
int32 |
|
CustomDirSkipBottom |
Integer |
Custom directory lines to skip at bottom |
int32 |
|
CustomDirSkipTop |
Integer |
Custom directory lines to skip at top |
int32 |
|
DataTimeout |
String |
Data timeout |
||
DefAB |
String |
Default ASCII vs binary transfer mode |
Enum: ascii, binary, |
|
DefAccount |
String |
Default account |
||
DefAddressFrom |
String |
Address from |
||
DefBlindDL |
String |
Default blind download enabled |
Enum: 0, 1, |
|
DefBlindUL |
String |
Default blind upload enabled |
Enum: 0, 1, |
|
DefClientCertSHA1 |
String |
Default client certificate SHA1 |
||
DefClientCertStore |
String |
Default client certificate store |
||
DefClientCertSubject |
String |
Default client certificate subject |
||
DefClientKeyID |
String |
Default client key ID |
||
DefConnTimeoutSecs |
Integer |
Default connection timeout in seconds |
int32 |
|
DefDataTimeoutSecs |
Integer |
Default data timeout in seconds |
int32 |
|
DefMD5File |
String |
Default MD5SUM filename |
||
DefMD5Get |
String |
Default whether to process MD5SUM files |
Enum: IfPresent, Never, Required, |
|
DefMxBy |
Long |
Default maximum number of bytes per task run |
int64 |
|
DefMxFi |
Integer |
Default maximum number of files per task run |
int32 |
|
DefPassive |
String |
Default whether to use passive mode |
Enum: 0, 1, |
|
DefPassword |
String |
Default password |
||
DefRescanSecs |
Integer |
Default rescan seconds |
int32 |
|
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefReuseSSL |
String |
Reuse SSL for data connections |
Enum: 0, 1, |
|
DefRsm |
String |
Default whether to resume failed transfers |
||
DefSort |
String |
Default sorting order |
Enum: Date,A, Date,D, Filename,A, Filename,D, Size,A, Size,D, |
|
DefUsername |
String |
Default username |
||
DefXS |
String |
Default flag for whether to do XSHA1 if available |
Enum: 0, 1, |
|
DelOldStateDays |
Integer |
Delete file stamp state entries after this many days (0=never) |
int32 |
|
Desc |
String |
Description |
||
DirScriptID |
String |
ID of directory parsing script |
||
DotNET |
String |
Ignored for FTP |
Enum: 0, 1, |
|
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
ID2 |
String |
ID of secondary host |
||
IgnoreCertProbs |
String |
Ignore certificate problems |
Enum: 0, 1, |
|
Name |
String |
Name of the object |
||
NatClientIP |
String |
NAT client IP address |
||
NatUseServerIPForData |
String |
NAT use server IP address for data |
Enum: 0, 1, |
|
PASVWS |
Integer |
Number of seconds to wait before connecting to passive port |
int32 |
|
ProxyHost |
String |
Proxy host |
||
ProxyPassword |
String |
Proxy password |
||
ProxyPort |
Integer |
Proxy port |
int32 |
|
ProxyType |
String |
Proxy type: one of None, SOCKS5 |
||
ProxyUsername |
String |
Proxy username |
||
RenameAfterUpload |
String |
Whether to rename after upload |
Enum: 0, 1, |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
ReuseSSLSession |
String |
Reuse SSL session |
Enum: 0, 1, |
|
SSHFingerprint |
String |
Fingerprint of SSH server key |
||
ScriptPath |
String |
Script path |
||
Secure |
String |
Session encryption type, one of: none, tls-p, tls-p-ccc, tls-c , tls-c-ccc, implicit, implicit-ccc |
||
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
TempUploadName |
String |
Temporary upload name |
||
UTCOffset |
Integer |
Offset from GMT, in seconds - used only by sync tasks |
int32 |
|
UseDefStateCaching |
String |
Use default state caching |
Enum: 0, 1, |
|
UseNotif |
String |
Not used for this host type |
Enum: 0, 1, |
|
host |
String |
Host |
||
port |
Integer |
Port |
int32 |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Features Enabled Features Enabled
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
key |
String |
Key |
||
value |
Boolean |
Value |
File Activity Report File Activity Report
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [File Activity Report Record] |
List of file activity report records |
|
sorting |
List of [Sorting Field] |
Sorting information |
File Activity Report Record File Activity Report Record
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Action |
String |
Action |
||
DestASxMDN |
String |
Destination AS1/AS2/AS3 MDN |
||
DestASxMsgID |
String |
Destination AS1/AS2/AS3 message ID |
||
DestBytes |
Double |
Destination byte count |
double |
|
DestDuration |
Double |
Destination duration in seconds |
double |
|
DestFile |
String |
Destination file |
||
DestFileID |
String |
Destination file ID |
||
DestHost |
String |
Destination host |
||
DestPath |
String |
Destination path |
||
LogID |
Long |
Log ID |
int64 |
|
LogStamp |
Date |
Log timestamp |
date-time |
|
Node |
Integer |
Node ID |
int32 |
|
NominalStart |
String |
Nominal start time |
||
QueryType |
String |
Query type |
||
ScheduledTime |
Date |
Scheduled time |
date-time |
|
SourceASxMDN |
String |
Source AS1/AS2/AS3 MDN |
||
SourceASxMsgID |
String |
Source AS1/AS2/AS3 message ID |
||
SourceBytes |
Double |
Source byte count |
double |
|
SourceDuration |
Double |
Source duration in seconds |
double |
|
SourceFile |
String |
Source file |
||
SourceFileID |
String |
Source file ID |
||
SourceHost |
String |
Source host |
||
SourcePath |
String |
Source path |
||
SourceStamp |
String |
Source timestamp (usually modified timestamp) |
||
StartTime |
Date |
Start time |
date-time |
|
Status |
String |
Status |
||
StatusCode |
Integer |
Numeric error code (or 0 if no error) |
int32 |
|
StatusMsg |
String |
Error or status message |
||
TaskID |
Integer |
Task ID |
int32 |
|
TaskName |
String |
Task name |
||
TransferBytes |
Double |
Transfer bytes |
double |
File System Share File System Share
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AdjDST |
String |
Whether host adjusts for DST |
Enum: 0, 1, |
|
DriveLetter |
String |
Drive letter |
||
Password |
String |
Password |
||
UNC |
String |
UNC |
||
UseNotif |
String |
Use filesystem notifications |
Enum: 0, 1, |
|
Username |
String |
Username |
FileSystem Host FileSystem Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AdjDST |
String |
Account for daylight savings |
Enum: 0, 1, |
|
DefMxBy |
Long |
Default maximum number of bytes per task run |
int64 |
|
DefMxFi |
Integer |
Default maximum number of files per task run |
int32 |
|
DefRescanSecs |
Integer |
Rescan period |
int32 |
|
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DelOldStateDays |
Integer |
Delete file stamp state entries after this many days (0=never) |
int32 |
|
Desc |
String |
Description |
||
Group |
List of [string] |
Groups the object belongs to |
||
Host |
String |
Hostname |
||
ID |
String |
ID of the object |
||
ID2 |
String |
ID of secondary host |
||
Name |
String |
Name of the object |
||
Port |
Integer |
Port number |
int32 |
|
RenameAfterUpload |
String |
Whether to rename after upload |
Enum: 0, 1, |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
Share |
List of [File System Share] |
Collection of file system shares |
||
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
TempUploadName |
String |
Temporary upload name |
||
UTCOffset |
Integer |
Offset from GMT, in seconds - used only by sync tasks |
int32 |
|
UseDefStateCaching |
String |
Use state caching |
Enum: 0, 1, |
|
UseNotif |
String |
Use filesystem notifications |
Enum: 0, 1, |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
For Step For Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ID |
String |
ID |
||
steps |
List of [object] |
Steps included in this for step. The type can be destination, email, for, if, process, runtask, source, updorig and when |
4.4.4. Frequency Frequency
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Interval |
List of Interval Interval |
List of intervals |
4.4.5. GlobalParameter, List Result GlobalParameter, List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of Parameter Parameter |
List of global parameters |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
Host List Result Host List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of host objects |
||
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
4.4.6. _Host, this model contains one of the following host types, File System host, FTP host, POP3 host, Share host, MOVEit Transfer host, SMTP host, SSHFTP host, AS1 host, AS2 host, AS3 host, or S3 host _ Host, this model contains one of the following host types, File System host, FTP host, POP3 host, Share host, MOVEit Transfer host, SMTP host, SSHFTP host, AS1 host, AS2 host, AS3 host, or S3 host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AS1 |
AS1 Host |
|||
AS2 |
AS2 Host |
|||
AS3 |
AS3 Host |
|||
FTP |
FTP Host |
|||
FileSystem |
FileSystem Host |
|||
POP3 |
POP3 Host |
|||
S3 |
S3 Host |
|||
SMTP |
SMTP Host |
|||
SSHFTP |
SSHFTP Host |
|||
Share |
Share Host |
|||
SiLock |
MOVEit Transfer Host |
If Step If Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ID |
String |
ID |
||
Otherwise |
Otherwise Step |
|||
When |
X |
List of [When Step] |
The condition to test, and the steps to take if it is true |
4.4.7. Information Information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Description |
X |
String |
Description of the configuration item |
|
Notes |
X |
String |
Notes of the configuration item |
4.4.8. Interval Interval
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
EndTime |
X |
String |
End time, in the format HH:MM |
|
EveryMinutes |
X |
Integer |
The interval between task runs, in minutes. |
int32 |
ID |
String |
ID of the interval |
||
StartTime |
X |
String |
Start time, in the format HH:MM |
|
value |
String |
This property is not used |
4.4.9. License License
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
acctMgtLicensed |
String |
Account management licensed |
Enum: 0, 1, |
|
advTasksLicensed |
String |
Advanced tasks licensed |
Enum: 0, 1, |
|
apiLicensed |
String |
API licensed |
Enum: 0, 1, |
|
as2Licensed |
String |
AS2 licensed |
Enum: 0, 1, |
|
backupHostsLicensed |
String |
Backup hosts licensed |
Enum: 0, 1, |
|
customScriptsLicensed |
String |
Custom scripts licensed |
Enum: 0, 1, |
|
maxHosts |
Long |
Max hosts |
int64 |
|
maxTasks |
Long |
Max tasks |
int64 |
|
pgpLicensed |
String |
PGP licensed |
Enum: 0, 1, |
|
resilEnabled |
String |
Resil enabled |
Enum: 0, 1, |
|
resilRole |
String |
Resil role |
||
version |
String |
Version |
MOVEit Transfer Host MOVEit Transfer Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AddCom |
String |
Add com |
||
AddComSignon |
String |
Add com signon |
||
AdjDST |
String |
Account for daylight savings |
Enum: 0, 1, |
|
CustomDir |
String |
Custom directory |
Enum: 0, 1, |
|
CustomDirColDate |
Integer |
Custom directory col date |
int32 |
|
CustomDirColFilename |
Integer |
Custom directory col filename |
int32 |
|
CustomDirSkipBottom |
Integer |
Custom directory skip bottom |
int32 |
|
CustomDirSkipTop |
Integer |
Custom directory skip top |
int32 |
|
DefAB |
String |
AB |
Enum: ascii, binary, |
|
DefAccount |
String |
Account |
||
DefAddressFrom |
String |
From address |
||
DefBlindDL |
String |
Blind DL |
Enum: 0, 1, |
|
DefBlindUL |
String |
Blind UL |
Enum: 0, 1, |
|
DefClientCertSHA1 |
String |
Client certificate SHA1 |
||
DefClientCertStore |
String |
Client certificate store |
||
DefClientCertSubject |
String |
Client certificate subject |
||
DefClientKeyID |
String |
Client key ID |
||
DefConnTimeoutSecs |
Integer |
Connection timeout in seconds |
int32 |
|
DefDataTimeoutSecs |
Integer |
Default data timeout in seconds |
int32 |
|
DefMD5File |
String |
Default MD5SUM filename |
||
DefMD5Get |
String |
Default whether to process MD5SUM files |
Enum: IfPresent, Never, Required, |
|
DefMxBy |
Long |
Default maximum number of bytes per task run |
int64 |
|
DefMxFi |
Integer |
Default maximum number of files per task run |
int32 |
|
DefPassive |
String |
Passive |
Enum: 0, 1, |
|
DefPassword |
String |
Password |
||
DefRescanSecs |
Integer |
Default rescan seconds |
int32 |
|
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefSort |
String |
Sort |
Enum: Date,A, Date,D, Filename,A, Filename,D, Size,A, Size,D, |
|
DefUsername |
String |
Username |
||
DelOldStateDays |
Integer |
Delete file stamp state entries after this many days (0=never) |
int32 |
|
Desc |
String |
Description |
||
DotNET |
String |
Whether target host uses .NET (should always be 1) |
Enum: 0, 1, |
|
Group |
List of [string] |
Groups the object belongs to |
||
Host |
String |
Host |
||
ID |
String |
ID of the object |
||
ID2 |
String |
ID of secondary host |
||
IgnoreCertProbs |
String |
Ignore certificate problems |
Enum: 0, 1, |
|
NATUseServerIPForData |
String |
NAT use server IP for data |
Enum: 0, 1, |
|
Name |
String |
Name of the object |
||
Port |
Integer |
Port |
int32 |
|
RenameAfterUpload |
String |
Whether to rename after upload |
Enum: 0, 1, |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
SSHFingerprint |
String |
SSH finger print |
||
ScriptPath |
String |
Script path |
||
Secure |
String |
Whether to encrypt the connection |
||
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
TempUploadName |
String |
Temporary upload name |
||
UseDefStateCaching |
String |
Use state caching |
Enum: 0, 1, |
|
UseNotif |
String |
Use filesystem notifications |
Enum: 0, 1, |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
4.4.10. MicSshKeyTypeListResultModel MicSshKeyTypeListResultModel
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Ssh Key] |
List of SSH keys |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
Next Action Next Action
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AddressTo |
String |
Email address to which mail should be sent, if Type is Email |
||
DoAfter |
String |
When this Next Action should be executed. A value of "FileDone" means after each file has been processed. A value of "Task" means after the task has finished. |
||
DoIfFailure |
String |
Do this when failed |
Enum: 0, 1, |
|
DoIfNoAction |
String |
Do this when no action |
Enum: 0, 1, |
|
DoIfSuccess |
String |
Do this when succeeded |
Enum: 0, 1, |
|
HostID |
String |
The ID of the SMTP host to use, if Type is Email |
||
ID |
String |
ID of the next action |
||
IsHTML |
String |
Indicate email format HTML vs plain text |
Enum: 0, 1, |
|
Message |
String |
The body of the email message, if Type is Email |
||
Parameters |
Parameters |
|||
Subject |
String |
The subject of the email message, if Type is Email |
||
TaskID |
String |
The ID of the task to run, if Type is Task |
||
Type |
String |
Type of the next action. A value of "Email" means send an email. A value of "Task" means run a task. |
Next actions Next actions
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
NextAction |
List of [Next Action] |
List of actions to take next |
Or Type Or Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comp |
X |
List of [Comp Type] |
comp |
Otherwise Step Otherwise Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
steps |
List of [object] |
Steps included in this Otherwise Step. The type can be Destination, Email, For, If, Process, RunTask, Source, UpdOrig and When |
PGP Key PGP Key
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Created |
String |
Created |
||
Disabled |
String |
Disabled |
Enum: 0, 1, |
|
Expired |
String |
Expired |
Enum: 0, 1, |
|
Expires |
String |
Expires |
||
Fingerprint |
String |
Fingerprint |
||
ID |
X |
String |
ID |
|
KeyLength |
String |
Key length |
||
KeyType |
String |
Key type |
||
Name |
String |
Name |
||
PubPriv |
String |
"pub" for public component only, or "pair" for keypair |
||
Revoked |
String |
Revoked |
Enum: 0, 1, |
|
Status |
String |
Status |
||
SymAlg |
X |
String |
Symmetric algorithm |
|
uid |
String |
UID (user ID) of key |
||
xAddEditDelete |
Boolean |
Add edit delete permission, readonly |
PGP Key List Result PGP Key List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [PGP Key] |
List of PGP key objects |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
POP3 Host POP3 Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
DefConnTimeoutSecs |
Integer |
Connection timeout in seconds |
int32 |
|
DefDataTimeoutSecs |
Integer |
Default data timeout in seconds |
int32 |
|
DefPassword |
String |
Password |
||
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefUsername |
String |
Username |
||
DelOldStateDays |
Integer |
Delete file stamp state entries after this many days (0=never) |
int32 |
|
Desc |
String |
Description |
||
Group |
List of [string] |
Groups the object belongs to |
||
Host |
String |
Host |
||
ID |
String |
ID of the object |
||
ID2 |
String |
ID of secondary host |
||
Name |
String |
Name of the object |
||
Port |
Integer |
Port |
int32 |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
UseDefStateCaching |
String |
Use state caching |
Enum: 0, 1, |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Paging Information Paging Information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
page |
X |
Integer |
Page number |
int32 |
perPage |
X |
Integer |
Number of objects per page |
int32 |
totalItems |
X |
Integer |
Total number of objects in the entire result set |
int32 |
totalPages |
X |
Integer |
Total number of pages in the entire result set |
int32 |
4.4.11. Parameter Parameter
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
countedDisplayValue |
String |
Counted Display Value |
||
displayValue |
String |
Display Value |
||
name |
String |
Name |
||
value |
String |
Value |
4.4.12. Parameters Parameters
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
any |
List of Parameter Parameter |
List of parameters |
4.4.13. Permissions Permissions
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
HostAddEditDelete |
String |
Add/edit/delete hosts |
Enum: 0, 1, |
|
PGPAddEditDelete |
String |
Add/edit/delete PGP keys |
Enum: 0, 1, |
|
SSHAddEditDelete |
String |
Add/edit/delete SSH keys |
Enum: 0, 1, |
|
SSLAddEditDelete |
String |
Add/edit/delete SSL certs |
Enum: 0, 1, |
|
ScriptAddEditDelete |
String |
Add/edit/delete scripts |
Enum: 0, 1, |
|
TaskAddEditDelete |
String |
Add/edit/delete tasks |
Enum: 0, 1, |
|
TaskEditExisting |
String |
Edit existing elements of the tasks |
Enum: 0, 1, |
|
TaskRun |
String |
Run tasks |
Enum: 0, 1, |
Process Step Process Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ID |
String |
ID |
||
IsDest |
String |
Whether this script should be regarded as acting like a destination |
Enum: 0, 1, |
|
Parameters |
Parameters |
|||
Run |
String |
When the process should run |
Enum: Once, PerFile, |
|
ScriptID |
X |
String |
ID of script to run |
Report Export Criteria Report Export Criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
delimiter |
String |
The delimiter symbol which will be used as separator in CSV-formatted exports. Defaults to comma (,) and supports tab ( ) as alternative option |
Enum: \t, |
|
format |
X |
String |
The format of the exported file. Supports XML and CSV formats. |
Enum: CSV, XML, |
qualifier |
String |
The qualifier symbol which will be used to quote each value in CSV-formatted exports. Defaults to double quotes (") and supports single quote (') as alternative option. |
Enum: ", ', |
|
queryInput |
X |
Report Query Input |
||
type |
X |
String |
The type of report. Supports TaskRuns, Activity and Audit report types. |
Enum: Activity, Audit, TaskRuns, |
Report Query Input Report Query Input
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
maxCount |
X |
Integer |
Maximum number of entries to return, must be in the range of 1 to 100,000 |
int32 |
orderBy |
X |
String |
Report result sorting order specified with comma-separated case-insensitive column names which can be optionally prefixed with `!` for descending order. Sorting order is by LogTime/LogStamp ascending if orderBy is empty. |
|
predicate |
X |
String |
Selection criteria using RSQL language to filter reporting data |
Resource Group Resource Group
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Members |
List of [Resource Group Member] |
Members of the resource group |
||
Name |
String |
Name of the resource group |
||
Notes |
String |
Description of the resource group |
||
xAddHost |
Boolean |
True if the current user can add hosts to this resource group |
||
xAddPGPKey |
Boolean |
True if the current user can add PGP keys to this resource group |
||
xAddSSHClientKey |
Boolean |
True if the current user can add SSH client keys to this resource group |
||
xAddSSLCert |
Boolean |
True if the current user can add SSL certs to this resource group |
||
xAddScript |
Boolean |
True if the current user can add scripts to this resource group |
||
xAddTask |
Boolean |
True if the current user can add tasks to this resource group |
Resource Group List Result Resource Group List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Resource Group] |
List of resource groups |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
Resource Group Member Resource Group Member
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
t |
String |
Type of the member |
Enum: host, pgp, script, ssh, ssl, task, |
|
value |
String |
ID of the member |
Run Task Step Run Task Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ID |
String |
ID |
||
TaskID |
X |
String |
TaskID |
|
Wait |
String |
Whether to wait until target task is complete before running |
Enum: 0, 1, |
|
items |
List of [object] |
This setting is not used |
Running Task Running Task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
CurFileBytes |
Long |
Current position in file |
int64 |
|
LastErrorText |
String |
Text description of the last error |
||
LastErrorType |
X |
Integer |
Type of the last error |
int32 |
NominalStart |
X |
String |
Nominal start of the running task |
|
StartedBy |
X |
String |
Username of the user who started the running task |
|
Status |
X |
String |
Current status of the running task |
|
StopRequested |
X |
String |
0 means the running task has not been requested to stop |
Enum: 0, 1, |
TaskID |
X |
String |
Id of the running task |
|
TaskName |
X |
String |
Name of the running task |
|
TimeStarted |
X |
String |
Start time of the running task |
|
TotFileBytes |
Long |
Total number of bytes in the file |
int64 |
|
xAddEditDelete |
Boolean |
True if the current user can add, edit or delete the running task |
||
xAlter |
Boolean |
True if the current user can alter the running task |
||
xRun |
Boolean |
True if the current user can run the running task |
Running Task List Result Running Task List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Running Task] |
List of running task objects |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
S3 Host S3 Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AdjDST |
String |
Account for daylight savings |
Enum: 0, 1, |
|
DefBucket |
String |
Default bucket |
||
DefConnTimeoutSecs |
Integer |
Connection timeout seconds |
int32 |
|
DefDLInteg |
String |
Default download integrity checking; one of never, ifsure, ignore, always |
||
DefDataTimeoutSecs |
Integer |
Default data timeout in seconds |
int32 |
|
DefMxBy |
Integer |
Default maximum number of bytes per task run |
int32 |
|
DefMxFi |
Integer |
Default maximum number of files per task run |
int32 |
|
DefPassword |
String |
Default secret access key |
||
DefRescanSecs |
Integer |
Default rescan seconds |
int32 |
|
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefUsername |
String |
Default access key id |
||
DelOldStateDays |
Integer |
Delete file stamp state entries after this many days (0=never) |
int32 |
|
Desc |
String |
Description |
||
Group |
List of [string] |
Groups the object belongs to |
||
Host |
String |
Host |
||
ID |
String |
ID of the object |
||
Name |
String |
Name of the object |
||
Port |
Integer |
Port |
int32 |
|
ProxyHost |
String |
Proxy host |
||
ProxyPassword |
String |
Proxy password |
||
ProxyPort |
Integer |
Proxy port |
int32 |
|
ProxyType |
String |
Proxy type: one of none, HTTP, or HTTPS |
||
ProxyUsername |
String |
Proxy username |
||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
S3AlternativeEndpoint |
String |
non AWS Endpoint URL |
||
Secure |
String |
Whether to encrypt the connection |
Enum: 0, 1, |
|
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
UseDefStateCaching |
String |
Use state caching |
Enum: 0, 1, |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
SMTP Host SMTP Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
DefAddressFrom |
String |
From address |
||
DefConnTimeoutSecs |
Integer |
Connection timeout in seconds |
int32 |
|
DefDataTimeoutSecs |
Integer |
Default data timeout in seconds |
int32 |
|
DefPassword |
String |
Password |
||
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefUsername |
String |
Username |
||
Desc |
String |
Description |
||
Group |
List of [string] |
Groups the object belongs to |
||
Host |
String |
Host |
||
ID |
String |
ID of the object |
||
ID2 |
String |
ID of secondary host |
||
IgnoreCertProbs |
String |
Ignore certificate problems |
Enum: 0, 1, |
|
Name |
String |
Name of the object |
||
Port |
Integer |
Port |
int32 |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
Secure |
String |
Whether to encrypt the connection |
||
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
UseDefStateCaching |
String |
Use state caching |
Enum: 0, 1, |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
SSHFTP Host SSHFTP Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AddCom |
String |
Add com |
||
AddComAX |
String |
Add com AX |
||
AddComSignon |
String |
Add com signon |
||
AdjDST |
String |
Account for daylight savings |
Enum: 0, 1, |
|
CmpL |
String |
Compression level, 0 - disable compression, 6 - enable compression |
Enum: 0, 6, |
|
CustomDir |
String |
Custom directory |
Enum: 0, 1, |
|
CustomDirColDate |
Integer |
Custom directory date column |
int32 |
|
CustomDirColFilename |
Integer |
Custom directory filename column |
int32 |
|
CustomDirSkipBottom |
Integer |
Custom directory lines to skip at bottom |
int32 |
|
CustomDirSkipTop |
Integer |
Custom directory lines to skip at top |
int32 |
|
DefAB |
String |
AB |
Enum: ascii, binary, |
|
DefAccount |
String |
Account |
||
DefAddressFrom |
String |
From address |
||
DefBlindDL |
String |
Blind downloads |
Enum: 0, 1, |
|
DefBlindUL |
String |
Blind uploads |
Enum: 0, 1, |
|
DefClientCertSHA1 |
String |
Client certificate SHA1 |
||
DefClientCertStore |
String |
Client certificate store |
||
DefClientCertSubject |
String |
Client certificate subject |
||
DefClientKeyID |
String |
Default client key ID |
||
DefConnTimeoutSecs |
Integer |
Connection timeout in seconds |
int32 |
|
DefDataTimeoutSecs |
Integer |
Default data timeout in seconds |
int32 |
|
DefDestFileAttr |
String |
Destination UNIX file attributes as an octal number |
||
DefMD5File |
String |
Default MD5SUM filename |
||
DefMD5Get |
String |
Default whether to process MD5SUM files |
Enum: IfPresent, Never, Required, |
|
DefMxBy |
Long |
Default maximum number of bytes per task run |
int64 |
|
DefMxFi |
Integer |
Default maximum number of files per task run |
int32 |
|
DefPassive |
String |
Passive |
Enum: 0, 1, |
|
DefPassword |
String |
Password |
||
DefRescanSecs |
Integer |
Default rescan seconds |
int32 |
|
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefRsm |
String |
Default whether to resume failed transfers |
||
DefSetFileAttr |
String |
Default whether to file attributes |
Enum: 0, 1, |
|
DefSort |
String |
Sort |
Enum: Date,A, Date,D, Filename,A, Filename,D, Size,A, Size,D, |
|
DefUsername |
String |
Username |
||
DelOldStateDays |
Integer |
Delete file stamp state entries after this many days (0=never) |
int32 |
|
Desc |
String |
Description |
||
DirScriptID |
String |
ID of directory parsing script |
||
DotNET |
String |
Ignored for SFTP |
Enum: 0, 1, |
|
EncAlg |
String |
Encryption algorithm override: empty, or one of aes, aes-cbc, aes-ctr, 3des, blowfish |
||
Group |
List of [string] |
Groups the object belongs to |
||
Host |
String |
Host |
||
ID |
String |
ID of the object |
||
ID2 |
String |
ID of secondary host |
||
IgnoreCertProbs |
String |
Whether to accept any server key |
Enum: 0, 1, |
|
KexAlgs |
String |
Prioritized list of acceptable key exchange algorithms |
||
NATUseServerIPForData |
String |
NAT user server IP for data |
Enum: 0, 1, |
|
Name |
String |
Name of the object |
||
OptimizeSSHBuf |
String |
Whether to optimize performance with lookahead buffers |
Enum: 0, 1, |
|
Port |
Integer |
Port |
int32 |
|
ProxyHost |
String |
Proxy host |
||
ProxyPassword |
String |
Proxy password |
||
ProxyPort |
Integer |
Proxy port |
int32 |
|
ProxyType |
String |
Proxy type: one of None, SOCKS4, SOCKS5, webstandard |
||
ProxyUsername |
String |
Proxy username |
||
RenameAfterUpload |
String |
Whether to rename after upload |
Enum: 0, 1, |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
SSHFingerprint |
String |
SSH finger print |
||
ScriptPath |
String |
Script path |
||
Secure |
String |
Whether to encrypt the connection |
||
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
TempUploadName |
String |
Temporary upload name |
||
UTCOffset |
Integer |
Offset from GMT, in seconds - used only by sync tasks |
int32 |
|
UseDefStateCaching |
String |
Use state caching |
Enum: 0, 1, |
|
UseNotif |
String |
Not used for this host type |
Enum: 0, 1, |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
SSL Certificate SSL Certificate
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ExpDate |
X |
String |
Expiration Date |
|
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
IssuedTo |
X |
String |
Issued To |
|
Issuer |
X |
String |
Issuer |
|
Name |
String |
Name of the object |
||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
SerialNum |
X |
String |
Serial Number |
|
Sha1Thumbprint |
X |
String |
SHA1 Thumbprint |
|
Store |
X |
String |
Store |
|
ValidFromDate |
X |
String |
Valid From Date |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
SSL Certificate List Result SSL Certificate List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [SSL Certificate] |
List of SSL Certificates |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
4.4.14. Schedule Schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
DateListRef |
List of [Date List Reference] |
Date list references |
||
Days |
Days |
|||
FailIfNoSuccessInSched |
String |
Whether to fail when no successes have occurred by the end of the schedule |
Enum: 0, 1, |
|
Frequency |
X |
Frequency |
||
ID |
String |
ID of the schedule |
||
Multi |
Integer |
Whether this schedule spans midnight. A value of 0 means the schedule does not span midnight. A value of 1 means this is the pre-midnight portion of a schedule that spans midnight. A value of 2 means this is the post-midnight portion of a schedule that spans midnight. |
int32 |
|
OnlyUntilFirstSuccess |
String |
Run the task during the scheduled time only until a task run was successful |
Enum: 0, 1, |
|
RunEvenIfNotif |
String |
Schedule the task even if all sources are subject to notifications |
Enum: 0, 1, |
4.4.15. Schedules Schedules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Schedule |
List of Schedule Schedule |
List of schedules |
Server Error Message Server Error Message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
detail |
X |
String |
An explanation specific to this occurrence of the error |
|
errorCode |
Integer |
The error code returned from the server |
int32 |
|
status |
X |
Integer |
The HTTP status code generated by the origin server for this occurrence of the error |
int32 |
title |
X |
String |
A short summary of the error type |
Server Timezone Info Server Timezone Info
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
daylightBias |
String |
Day light bias |
||
timeZoneBias |
String |
Time zone bias |
||
timeZoneName |
String |
Time zone name |
Share Host Share Host
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AdjDST |
String |
Account for daylight savings |
Enum: 0, 1, |
|
DefMxBy |
Long |
Default maximum number of bytes per task run |
int64 |
|
DefMxFi |
Integer |
Default maximum number of files per task run |
int32 |
|
DefPassword |
String |
Password |
||
DefRescanSecs |
Integer |
Default rescan seconds |
int32 |
|
DefRetryCount |
Integer |
Default number of retries |
int32 |
|
DefRetryTimeoutSecs |
Integer |
Default retry timeout value in seconds |
int32 |
|
DefUsername |
String |
Username |
||
DefWinCopyFileAPI |
String |
Win copy file API |
Enum: 0, 1, |
|
DelOldStateDays |
Integer |
Delete file stamp state entries after this many days (0=never) |
int32 |
|
Desc |
String |
Description |
||
DriveLetter |
String |
Drive letter |
||
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
ID2 |
String |
ID of secondary host |
||
Name |
String |
Name of the object |
||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
StateCacheTime |
Integer |
Length of time to cache state; -1=forever |
int32 |
|
StateCacheUnit |
String |
State cache unit |
Enum: Hours, Minutes, |
|
UNC |
String |
UNC |
||
UseDefStateCaching |
String |
Use state caching |
Enum: 0, 1, |
|
UseNotif |
String |
Use filesystem notifications |
Enum: 0, 1, |
|
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Sorting Field Sorting Field
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
sortDirection |
X |
String |
Sorting order |
Enum: asc, desc, |
sortField |
X |
String |
Field name |
Source Step Source Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AB |
String |
ASCII vs binary transfer mode; applies only to FTP |
Enum: ascii, binary, |
|
Account |
String |
The account to use during authentication; for FTP only. Rarely used. |
||
AddCom |
String |
Commands to execute (per file) before transfer; applies only to FTP |
||
AddComAX |
String |
Commands to execute (per file) after transfer; applies only to FTP |
||
BlindDL |
String |
Blind download enabled: if enabled, no directory listing is done prior to download |
Enum: 0, 1, |
|
Bucket |
String |
S3 bucket name; for AWS S3 only |
||
ClientCertSHA1 |
String |
Client certificate SHA1 |
||
ClientCertStore |
String |
Client certificate store |
||
ClientCertSubject |
String |
Client certificate subject |
||
ClientKeyID |
String |
Client key ID |
||
ConnTimeoutSecs |
Integer |
Connection timeout seconds |
int32 |
|
Criteria |
Criteria Type |
|||
DLInteg |
String |
Whether to use download integrity checking. Must be one of "never", "ifsure", "ignore", or "always". Applies only to S3 hosts. |
||
DataTimeoutSecs |
Integer |
Data timeout in seconds |
int32 |
|
DelRename |
String |
Whether to delete the "to" filename when renaming a downloaded file. +Applies only if DeleteOrig = 2. |
Enum: 0, 1, |
|
DeleteOrig |
String |
What to do with a downloaded file after processing |
Enum: 0, 1, 2, |
|
DestFileAttr |
String |
Destination file attribute |
||
DownloadGroup |
String |
Set this to "Collection" if downloading a "bundle" of web posts. This is a rarely-used feature that applies only to MOVEit Transfer hosts. |
||
ExFile |
String |
Mask of file names to be excluded from download |
||
ExFo |
String |
Mask of folder names to be excluded from download |
||
FileMask |
String |
Mask that files must match to be downloaded |
||
FolderID |
String |
MOVEit Transfer folder ID |
||
FolderName |
String |
Folder name |
||
FolderType |
String |
Folder type; rarely-used setting that applies only to MOVEit Transfer hosts |
Enum: -1, 1, 10, 110, 119, 19, 4, 99, |
|
Format |
String |
Format in which to download a web post bundle; either "CSV" or "XML". This is a rarely-used feature that applies only to MOVEit Transfer hosts. |
Enum: CSV, XML, |
|
HostID |
String |
ID of associated host |
||
ID |
String |
ID |
||
MD5File |
String |
Filename of the MD5SUM file; used only by FTP and SFTP |
||
MD5Get |
String |
Whether to process MD5SUM files |
Enum: IfPresent, Never, Required, |
|
MDNFilenameToSend |
String |
MDN filename to send |
||
MDNPath |
String |
Path of the Message Disposition Notification; used only by AS/x |
||
MxBy |
Long |
Maximum number of bytes per task run |
int64 |
|
MxFi |
Integer |
Maximum number of files per task run |
int32 |
|
NewFilesOnly |
String |
New files only |
Enum: 0, 1, |
|
PartnerName |
String |
Partner name |
||
Passive |
String |
Whether to use passive mode; used only by FTP |
Enum: 0, 1, |
|
Password |
String |
Password |
||
Path |
String |
Folder path of the source or destination |
||
RenameTo |
String |
What to rename a downloaded file to after processing. Applies only if DeleteOrig = 2. |
||
RescanSecs |
Integer |
Rescan in seconds |
int32 |
|
RetryCount |
Integer |
Retry count |
int32 |
|
RetryIfNoFiles |
String |
Whether to rescan for files if none were found |
Enum: 0, 1, |
|
RetryTimeoutSecs |
Integer |
Retry timeout in seconds |
int32 |
|
ReuseSSL |
String |
Whether to reuse SSL sessions; for FTP only |
Enum: 0, 1, |
|
Rsm |
Integer |
Whether to attempt resume of transfers; 0 means no and 1 means yes |
int32 |
|
SearchSubdirs |
String |
Whether to search subdirectories |
Enum: 0, 1, |
|
SetFileAttr |
String |
Whether to set file attributes after upload, if UseDefSetFileAttr is false |
Enum: 0, 1, |
|
Sort |
String |
Desired sorting of files from a MOVEit Transfer host. Allowed values are "Name,N", "Size,N", or "Date,N" where N=A or D, for Ascending and Descending |
Enum: Date,A, Date,D, Filename,A, Filename,D, Size,A, Size,D, |
|
SubjectMatch |
String |
Mask of email subject that must match for download. Applies only to AS/1 hosts. |
||
SyDel |
String |
Whether to synchronize deletions. Applies only to Sync tasks. |
Enum: 0, 1, 2, |
|
SyF |
String |
Whether this is the "from" source. Applies only to Sync tasks. |
Enum: 0, 1, |
|
SyT |
String |
Whether this is the "to" source. Applies only to Sync tasks. |
Enum: 0, 1, |
|
Type |
String |
The host type of this step |
Enum: AS1, AS2, AS3, AzureBlob, FTP, FileSystem, POP3, S3, SMTP, SSHFTP, Share, SharePoint, siLock, |
|
UDMxBy |
String |
Use the host's default maximum bytes |
Enum: 0, 1, |
|
UDMxFi |
String |
Use the host's default maximum files |
Enum: 0, 1, |
|
Unzip |
String |
Whether to unzip files whose name ends in .zip |
Enum: 0, 1, |
|
UseDefAB |
String |
Use the host's default ASCII vs binary; applies only to FTP |
Enum: 0, 1, |
|
UseDefBlindDL |
String |
Use the host's default blind download setting |
Enum: 0, 1, |
|
UseDefBucket |
String |
Whether to use the host's default bucket; for S3 only |
Enum: 0, 1, |
|
UseDefClientCert |
String |
Use the host's default client certificate |
Enum: 0, 1, |
|
UseDefClientKey |
String |
Use the host's default client key |
Enum: 0, 1, |
|
UseDefConnTimeoutSecs |
String |
Use the host's default connection timeout in seconds |
Enum: 0, 1, |
|
UseDefDLInteg |
String |
Use the host's default download integrity settings |
Enum: 0, 1, |
|
UseDefDataTimeoutSecs |
String |
Use the host's default data timeout in seconds |
Enum: 0, 1, |
|
UseDefMD5File |
String |
Use the host's default MD5 file |
Enum: 0, 1, |
|
UseDefMD5Get |
String |
Use the host's default setting for whether to process MD5SUM files |
Enum: 0, 1, |
|
UseDefPartner |
String |
Use default partner |
Enum: 0, 1, |
|
UseDefPassive |
String |
Use the host's default passive |
Enum: 0, 1, |
|
UseDefRescanSecs |
String |
Use the host's default rescan seconds |
Enum: 0, 1, |
|
UseDefRetryCount |
String |
Use the host's default retry count |
Enum: 0, 1, |
|
UseDefRetryTimeoutSecs |
String |
Use the host's default retry timeout in seconds |
Enum: 0, 1, |
|
UseDefReuseSSL |
String |
Use the host's default reuse SSL; for FTP only |
Enum: 0, 1, |
|
UseDefRsm |
String |
Use the host's default resume of file transfers |
Enum: 0, 1, |
|
UseDefSetFileAttr |
String |
Use the host's default set file attribute |
Enum: 0, 1, |
|
UseDefSort |
String |
Use the host's default sort |
Enum: 0, 1, |
|
UseDefUser |
String |
Use the host's default user |
Enum: 0, 1, |
|
UseDefWinCopyFileAPI |
String |
Use the host's default Windows copy file API setting |
Enum: 0, 1, |
|
UseDefXS |
String |
Use the host's default setting whether to check integrity via XSHA1. For FTP only. |
Enum: 0, 1, |
|
UseLCaseComp |
String |
Use lower case filename comparisons |
Enum: 0, 1, |
|
UseWinCopyFileAPI |
String |
Which file copy algorithm to use for UNC hosts. A value of 0 means use the Windows API function CopyFileEx, which is generally faster. This is the recommended setting. A value of 1 means use a read/write loop. |
Enum: 0, 1, |
|
Username |
String |
Username |
||
XS |
String |
Whether to use XSHA1 for integrity checking. For FTP only. A value of 0 means do not use XSHA1; a value of 1 means do use XSHA1. |
Ssh Key Ssh Key
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Fingerprint |
X |
String |
Fingerprint |
|
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
Name |
String |
Name of the object |
||
PublicKeyOpenSSH |
X |
String |
Public key in OpenSSH format |
|
PublicKeySSH |
X |
String |
Public key in SSH format |
|
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Standard Script Standard Script
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Description |
String |
Description |
||
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
IsDest |
Boolean |
Is a destination script |
||
Name |
String |
Name of the object |
||
Params |
Parameters |
|||
ProcessDesc |
String |
Process description |
||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Standard Script List Result Standard Script List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Standard Script] |
List of standard scripts |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
Start Task Response Start Task Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
nominalStart |
String |
Nominal Start time of the task. |
Steps Type Steps Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
MicDestinationType |
Destination Step |
|||
MicEmailType |
Email Step |
|||
MicForType |
For Step |
|||
MicIfType |
If Step |
|||
MicProcessType |
Process Step |
|||
MicRunTaskType |
Run Task Step |
|||
MicSourceType |
Source Step |
|||
MicUpdOrigType |
Update Original Step |
Stop Task Input Stop Task Input
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
nominalStart |
String |
Nominal Start time of the task. |
4.4.16. Task Task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
AR |
String |
1 means that the task should automatically be rerun if any source hits a maxfiles or maxbytes limit. |
Enum: 0, 1, |
|
Active |
String |
0 means the task is never run by the scheduler or any of the notifiers. |
Enum: 0, 1, |
|
CAS |
String |
"Compare Across Sources", an advanced sync-only option that is no longer supported. |
Enum: A, EMPTY, N, |
|
CacheNames |
String |
"random" (the default) means cache files have random names. "orig" means that original names are retained; this is necessary for some scripts, but can be problematic if the same filename appears on more than one source. |
Enum: orig, random, |
|
Group |
List of [string] |
Groups the object belongs to |
||
ID |
String |
ID of the object |
||
Info |
Information |
|||
Name |
String |
Name of the object |
||
NextActions |
Next actions |
|||
NextEID |
Integer |
Next entity ID. This is used by Admin to assign IDs to elements. Not needed by the server. |
int32 |
|
NumTaskLogsToKeep |
Long |
Number of task logs to keep for this task. Default is to use the global setting. |
int64 |
|
Parameters |
Parameters |
|||
Renamed |
Boolean |
Whether the object has been renamed, readonly |
||
SameSecs |
Long |
This task attribute will describe how far apart two timestamps can still be considered the same. It is used during an initial sync run, when we must compare files across systems whose clocks may not be synced.This number applies after timezone and DST adjustments have been made. The default will be 43200 seconds (12 hours). A value of -1 means that timestamps are always considered the same. A value of -2 means that timestamps are always considered different; i.e., copy all files, even if they have not been modified. A value of -3 means that changes in file time and file size are ignored; i.e., the files will be treated as if not modified. Note: this should be implemented as a signed long integer. |
int64 |
|
Scheduled |
String |
Readonly - Scheduled status of the task |
Enum: DISABLED, ENABLED, INCOMPLETE, UNSCHEDULED, |
|
Schedules |
Schedules |
|||
StateCacheTime |
Integer |
How long the task's state should be retained. A value of -1 means retain the state forever. A value of 0 means retain the state until the end of the task run. A value > 0 means retain the state until that amount of time after the last task run. (See StateCacheUnit.) |
int32 |
|
StateCacheUnit |
String |
State cache unit: "hours" or "minutes". Default is minutes. |
Enum: Hours, Minutes, |
|
TT |
String |
Task type. "Sy" - Synchronization, "COS" - Advanced task, Empty (default) - Traditional. |
Enum: COS, EMPTY, Sy, |
|
UseDefStateCaching |
String |
Whether to use the default state caching policy. 0 means that the task's StateCacheTime and StateCacheUnit apply. 1 means use the system setting. |
Enum: 0, 1, |
|
steps |
List of [Steps Type] |
Steps included in the task. The type can be Destination, Email, For, If, Process, RunTask, Source and UpdOrig. |
||
xAddEditDelete |
Boolean |
Whether is permitted to add, edit and delete the object, readonly |
||
xAlter |
Boolean |
Whether is permitted to alter the task's existing elements, readonly |
||
xRun |
Boolean |
Whether is permitted to run the task, readonly |
Task List Result Task List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of Task Task |
List of task objects |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
Task Log Task Log
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
exitStatus |
String |
Status of task run |
||
id |
Long |
Task Log Id |
int64 |
|
logPath |
String |
Path to location of log file |
||
startTime |
String |
Time the task run started |
||
taskId |
Long |
Task Id |
int64 |
Task Log List Result Task Log List Result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Task Log] |
List of task logs |
|
paging |
X |
Paging Information |
||
sorting |
List of [Sorting Field] |
Sorting information |
Task Runs Report Task Runs Report
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
items |
X |
List of [Task Runs Report Record] |
List of task runs report records |
|
sorting |
List of [Sorting Field] |
Sorting information |
Task Runs Report Record Task Runs Report Record
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
DurationSecond |
Long |
Duration in seconds |
int64 |
|
EndTime |
Date |
End time |
date-time |
|
FilesSent |
Integer |
Number of files sent |
int32 |
|
LogStamp |
Date |
Log timestamp |
date-time |
|
Node |
Integer |
Node ID |
int32 |
|
NominalStart |
String |
Nominal start time |
||
QueryType |
String |
Query type |
||
RecType |
String |
Record type |
||
RunID |
Long |
Task run ID |
int64 |
|
ScheduledTime |
Date |
Scheduled time |
date-time |
|
StartTime |
Date |
Start time |
date-time |
|
StartedBy |
String |
Started by |
||
Status |
String |
Status |
||
StatusCode |
Integer |
Numeric error code (or 0 if no error) |
int32 |
|
StatusMsg |
String |
Error or status message |
||
TaskID |
Integer |
Task ID |
int32 |
|
TaskName |
String |
Task name |
||
TotalBytesSent |
Double |
Total bytes sent |
double |
Task Scheduler Status Response Task Scheduler Status Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
status |
String |
Status of the scheduler |
Enum: SCHEDULER_DISABLED_BY_OPERATOR, SCHEDULER_DISABLED_FAILOVER, SCHEDULER_DISABLED_STARTUP, SCHEDULER_ENABLED, SCHEDULER_STATUS_UNKNOWN, |
Update Original Step Update Original Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
Action |
X |
String |
The action to take: "d" to delete, "r" to rename, or empty to take no action |
|
DelRename |
String |
Whether we should delete the "rename to" file before renaming |
Enum: 0, 1, |
|
ID |
String |
ID |
||
RenameTo |
String |
If action is rename, the new name (may include macros) |
User Group User Group
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
d |
String |
Description |
||
name |
String |
Name |
Validation Error Validation Error
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
field |
String |
Name of the field having this validation error |
||
message |
X |
String |
The explanation of this occurrence of the error |
|
rejected |
String |
Value of the field having this validation error |
Validation Error Message Validation Error Message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
detail |
String |
An explanation specific to this occurrence of the error |
||
errors |
X |
List of [Validation Error] |
List of validation errors |
|
status |
X |
Integer |
The HTTP status code generated by the origin server for this occurrence of the error |
int32 |
title |
String |
A short summary of the error type |
When Step When Step
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
criteria |
X |
Criteria Type |
||
steps |
List of [object] |
Steps included in this When step. The type can be Destination, Email, For, If, Process, RunTask, Source, UpdOrig and When |