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.

Important
 The REST API is an optionally licensed feature that runs at the MOVEit Automation Server. It is subject to the terms of the MOVEit Automation End User License Agreement.

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.

The following resources are available through the MOVEit Automation REST API:

Resource Description

/api/v1/token

Request or refresh an authorization token.

/api/v1/info

Get MOVEit Automation application information.

/api/v1/config

Download or upload an unencrypted copy of the MOVEit Automation config.xml file.

/api/v1/customscripts

List all custom scripts or get a specified custom script.

/api/v1/datelists

List all date lists or get a specified date list.

/api/v1/globalparameters

List global parameters or get a specified global parameter.

/api/v1/hosts

List or get a host.

/api/v1/pgpkeys

List all PGP keys or get a specified PGP key.

/api/v1/reports

Generate reports for tasks runs, file activity, or audit logs.

/api/v1/resourcegroups (2019.1 only)

List or get a Resource Group. List or get an ACL. Add, delete, or update an existing ACL.

/api/v1/sshkeys

List all SSH keys or get a specified SSH key.

/api/v1/sslcerts

List all SSL certs or get a specified SSL cert.

/api/v1/standardscripts

List all standard scripts or get a specified standard script.

/api/v1/taskgroups (Deprecated in 2019.1. Use Resource Groups API

List task groups or get a specified task group.)

/api/v1/tasks

Delete a task, list tasks, list running tasks, 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.

/api/v1/usergroups (2019.1 only)

List or get a User Group.

/swagger-ui.html

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

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.

  1. Select Authorization Token API in the Select a spec list.

  2. Click Authorization Token > POST /api/v1/token.

  3. Click Try it out.

  4. Enter the following:

    • grant_type is "password"

    • server_host (If the server_host value is not specified, the first configured MOVEit Automation server is used.)

    • username

    • password

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

  1. Select MOVEit Automation REST API in the Select a spec list.

  2. Click Authorize.

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

  4. 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. Ipswitch MOVEit Automation - Authorization Token API

3.1. Overview

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.1.1. Version information

Version : V1

3.1.2. URI scheme

Host : localhost
BasePath : /

3.1.3. Tags

  • Authorization Token : Authorization Token API

3.2. Paths

3.2.1. Request or refresh an authorization token

POST /api/v1/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
Type Name Description Schema

FormData

grant_type
required

The grant or method type required. Valid values are "password" or "refresh_token".

string

FormData

password
optional

The password for the specified username. Associated with the "password" grant type only. Required.

string

FormData

refresh_token
optional

Use the refresh token to get a new access token. Associated with the "refresh_token" grant type only. Required.

string

FormData

server_host
optional

The host name or IP address of the MOVEit Automation server. Associated with the "password" grant type only. Optional.

string

FormData

username
optional

The username of the user with access rights. Associated with the "password" grant type only. Required.

string
Responses
HTTP Code Description Schema

200

OK

Authorization Token

400

Bad Request

Authorization token error

500

Internal Server Error

Server Error Message
Consumes

  • application/x-www-form-urlencoded

Produces

  • application/json

Tags

  • Authorization Token

3.2.2. Revoke an authorization token

POST /api/v1/token/revoke
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
Type Name Description Schema

FormData

token
optional

The access or refresh token to be revoked. Required

string
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

Authorization token error

500

Internal Server Error

Server Error Message
Consumes

  • application/x-www-form-urlencoded

Produces

  • application/json

Tags

  • Authorization Token

3.3. Definitions

3.3.1. Authorization Token

Name Description Schema

access_token
optional

Token used for accessing the application REST API

string

expires_in
optional

The lifetime in seconds of the access token

integer (int64)

refresh_token
optional

Token used for obtaining a new authorization token. Cannot be used to access the application REST API directly.

string

token_type
optional

Type of the access token, case-insensitive. Only "bearer" is supported currently.

string

3.3.2. Authorization token error

Name Description Schema

error
required

Error code

string

error_description
required

Description of the error with additional information

string

3.3.3. Server Error Message

Name Description Schema

detail
required

An explanation specific to this occurrence of the error

string

errorCode
optional

The error code returned from the server

integer (int32)

status
required

The HTTP status code generated by the origin server for this occurrence of the error

integer (int32)

title
required

A short summary of the error type

string

4. Ipswitch MOVEit Automation - REST API

4.1. Overview

The MOVEit Automation REST API accesses resources on the MOVEit Automation Server

4.1.1. Version information

Version : V1

4.1.2. URI scheme

Host : localhost
BasePath : /

4.1.3. Tags

  • About Info : MOVEit Automation application information API

  • Config : Config API

  • Custom Scripts : Custom Scripts API

  • Date Lists : Date List API

  • Global Parameters : Global Parameters API

  • Hosts : Hosts API

  • PGP Keys : Custom Scripts API

  • Reports : Reports API

  • Resource Groups : Resource Groups API

  • SSH Keys : SSH Keys API

  • SSL Certificates : SSL Certificates API

  • Standard Scripts : Standard Scripts API

  • Task Groups : Task Groups API

  • Tasks : Tasks API

  • User Groups : User groups API

4.2. Security

4.2.1. accessToken

Type : apiKey
Name : Authorization
In : HEADER

4.3. Paths

4.3.1. Download an unencrypted copy of the MOVEit Automation config.xml file

GET /api/v1/config
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.

Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • */*

Tags

  • Config

Security
Type Name Scopes

apiKey

accessToken

global

4.3.2. Upload an unencrypted copy of the MOVEit Automation config.xml file

PUT /api/v1/config
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
Type Name Description Schema

Body

xmlConfig
required

The configuration xml file to import

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/xml

Produces

  • */*

Tags

  • Config

Security
Type Name Scopes

apiKey

accessToken

global

4.3.3. List all custom scripts

GET /api/v1/customscripts
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Custom Script List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Custom Scripts

Security
Type Name Scopes

apiKey

accessToken

global

4.3.4. Get a custom script

GET /api/v1/customscripts/{customScriptId}
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
Type Name Description Schema

Path

customScriptId
required

The Custom Script ID

string
Responses
HTTP Code Description Schema

200

OK

Custom Script

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Custom Scripts

Security
Type Name Scopes

apiKey

accessToken

global

4.3.5. List all date lists

GET /api/v1/datelists
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Date List, List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Date Lists

Security
Type Name Scopes

apiKey

accessToken

global

4.3.6. Get a date list

GET /api/v1/datelists/{dateListId}
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
Type Name Description Schema

Path

dateListId
required

The Date List ID

string
Responses
HTTP Code Description Schema

200

OK

Date List

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Date Lists

Security
Type Name Scopes

apiKey

accessToken

global

4.3.7. List global parameters

GET /api/v1/globalparameters
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

GlobalParameter, List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Global Parameters

Security
Type Name Scopes

apiKey

accessToken

global

4.3.8. Get global parameter

GET /api/v1/globalparameters/{name}
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
Type Name Description Schema

Path

name
required

The Global Parameter Name

string
Responses
HTTP Code Description Schema

200

OK

Global Parameter

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Global Parameters

Security
Type Name Scopes

apiKey

accessToken

global

4.3.9. List hosts

GET /api/v1/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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)

Query

type
optional

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.

string
Responses
HTTP Code Description Schema

200

OK

Host List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Hosts

Security
Type Name Scopes

apiKey

accessToken

global

4.3.10. Get a host

GET /api/v1/hosts/{hostId}
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
Type Name Description Schema

Path

hostId
required

The Host ID

string
Responses
HTTP Code Description Schema

200

OK

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

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Hosts

Security
Type Name Scopes

apiKey

accessToken

global

4.3.11. Get MOVEit Automation application information

GET /api/v1/info
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.

Responses
HTTP Code Description Schema

200

OK

About Info

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • About Info

Security
Type Name Scopes

apiKey

accessToken

global

4.3.12. List all PGP keys

GET /api/v1/pgpkeys
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)

Query

uid
optional

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.

string
Responses
HTTP Code Description Schema

200

OK

PGP Key List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • PGP Keys

Security
Type Name Scopes

apiKey

accessToken

global

4.3.13. Get a PGP key

GET /api/v1/pgpkeys/{pgpKeyId}
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
Type Name Description Schema

Path

pgpKeyId
required

The PGP Key ID

string
Responses
HTTP Code Description Schema

200

OK

PGP Key

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • PGP Keys

Security
Type Name Scopes

apiKey

accessToken

global

4.3.14. Generate an Audit report

POST /api/v1/reports/audit
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.

{
  "predicate": "Status=in=(\"Success\",\"Failure\");TaskName=like=\"%hello\\\"\\\\%\\\\_\\\\world%\"",
  "orderBy": "!StartTime",
  "maxCount": 100
}

or use single quote for predicate,

{
  "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
Type Name Description Schema

Body

Query input
required

The report query input

Report Query Input
Responses
HTTP Code Description Schema

200

OK

Audit Report

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Reports

Security
Type Name Scopes

apiKey

accessToken

global

4.3.15. Generate a File Activity report

POST /api/v1/reports/fileactivity
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.

{
  "predicate": "Status=in=(\"Success\",\"Failure\");TaskName=like=\"%hello\\\"\\\\%\\\\_\\\\world%\"",
  "orderBy": "!StartTime",
  "maxCount": 100
}

or use single quote for predicate,

{
  "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
Type Name Description Schema

Body

Query input
required

The report query input

Report Query Input
Responses
HTTP Code Description Schema

200

OK

File Activity Report

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Reports

Security
Type Name Scopes

apiKey

accessToken

global

4.3.16. Generate a Task Runs report

POST /api/v1/reports/taskruns
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.

{
  "predicate": "Status=in=(\"Success\",\"Failure\");TaskName=like=\"%hello\\\"\\\\%\\\\_\\\\world%\"",
  "orderBy": "!StartTime",
  "maxCount": 100
}

or use single quote for predicate,

{
  "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
Type Name Description Schema

Body

Query input
required

The report query input

Report Query Input
Responses
HTTP Code Description Schema

200

OK

Task Runs Report

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Reports

Security
Type Name Scopes

apiKey

accessToken

global

4.3.17. List resource groups (2019.1 only)

GET /api/v1/resourcegroups
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Resource Group List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Resource Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.18. Add a new ACL (2019.1 only)

POST /api/v1/resourcegroups/acls
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:

{
   "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
Type Name Description Schema

Body

acl
required

ACL

Access Control List
Responses
HTTP Code Description Schema

201

Created

Access Control List

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Resource Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.19. List access control lists (2019.1 only)

GET /api/v1/resourcegroups/acls
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)

Query

resourceGroupName
optional

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.

string

Query

userGroupName
optional

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.

string
Responses
HTTP Code Description Schema

200

OK

Access Control List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Resource Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.20. Get access control list (2019.1 only)

GET /api/v1/resourcegroups/acls/{aclId}
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
Type Name Description Schema

Path

aclId
required

The ACL ID

string
Responses
HTTP Code Description Schema

200

OK

Access Control List

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Resource Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.21. Update existing ACL (2019.1 only)

PUT /api/v1/resourcegroups/acls/{aclId}
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
Type Name Description Schema

Path

aclId
required

The ACL ID

string

Body

aclId
required

ACL

Access Control List
Responses
HTTP Code Description Schema

200

OK

Access Control List

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Resource Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.22. Delete an ACL (2019.1 only)

DELETE /api/v1/resourcegroups/acls/{aclId}
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
Type Name Description Schema

Path

aclId
required

The ACL ID

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • */*

Tags

  • Resource Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.23. Get a resource group (2019.1)

GET /api/v1/resourcegroups/{resourceGroupName}
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
Type Name Description Schema

Path

resourceGroupName
required

The Resource Group Name

string
Responses
HTTP Code Description Schema

200

OK

Resource Group

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Resource Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.24. List all SSH keys

GET /api/v1/sshkeys
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

MicSshKeyTypeListResultModel

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • SSH Keys

Security
Type Name Scopes

apiKey

accessToken

global

4.3.25. Get SSH key

GET /api/v1/sshkeys/{sshKeyId}
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
Type Name Description Schema

Path

sshKeyId
required

The SSH Key ID

string
Responses
HTTP Code Description Schema

200

OK

Ssh Key

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • SSH Keys

Security
Type Name Scopes

apiKey

accessToken

global

4.3.26. List all SSL Certificates

GET /api/v1/sslcerts
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

issuer
optional

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.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

SSL Certificate List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • SSL Certificates

Security
Type Name Scopes

apiKey

accessToken

global

4.3.27. Get SSL Certificate

GET /api/v1/sslcerts/{sslCertificateThumbprint}
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
Type Name Description Schema

Path

sslCertificateThumbprint
required

The SSL Certificate Thumbprint

string
Responses
HTTP Code Description Schema

200

OK

SSL Certificate

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • SSL Certificates

Security
Type Name Scopes

apiKey

accessToken

global

4.3.28. List all standard scripts

GET /api/v1/standardscripts
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Standard Script List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Standard Scripts

Security
Type Name Scopes

apiKey

accessToken

global

4.3.29. Get a standard script

GET /api/v1/standardscripts/{standardScriptId}
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
Type Name Description Schema

Path

standardScriptId
required

The Standard Script ID

string
Responses
HTTP Code Description Schema

200

OK

Standard Script

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Standard Scripts

Security
Type Name Scopes

apiKey

accessToken

global

4.3.30. List task groups (Deprecated. Use Resource Groups API)

GET /api/v1/taskgroups
Caution

operation.deprecated
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Resource Group List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Task Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.31. Get a task group (Deprecated. Use Resource Groups API)

GET /api/v1/taskgroups/{taskGroupName}
Caution

operation.deprecated
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
Type Name Description Schema

Path

taskGroupName
required

The Task Group Name

string
Responses
HTTP Code Description Schema

200

OK

Resource Group

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Task Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.32. Add a new task

POST /api/v1/tasks
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:

{
    "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
Type Name Description Schema

Body

task
required

Task

Task
Responses
HTTP Code Description Schema

201

Created

Task

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.33. List tasks

GET /api/v1/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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Task List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.34. List running tasks

GET /api/v1/tasks/running
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
Type Name Description Schema

Query

fields
optional

Comma-separated, case-sensitive top-level Task field names. Invalid field names will be ignored

string

Query

name
optional

The case-insensitive task search name.

string

Query

page
optional

Page number (from 1)

integer (int32)

Query

perPage
optional

Number of tasks per page

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Running Task List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.35. Start/Stop scheduler

PUT /api/v1/tasks/scheduler/{startStop}
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
Type Name Description Schema

Path

startStop
required

Valid values are "start" or "stop".

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • */*

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.36. Get a task

GET /api/v1/tasks/{taskId}
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
Type Name Description Schema

Path

taskId
required

The Task ID

string
Responses
HTTP Code Description Schema

200

OK

Task

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.37. Update an existing task

PUT /api/v1/tasks/{taskId}
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
Type Name Description Schema

Path

taskId
required

The Task ID

string

Body

task
required

Task

Task
Responses
HTTP Code Description Schema

200

OK

Task

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.38. Delete a task

DELETE /api/v1/tasks/{taskId}
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
Type Name Description Schema

Path

taskId
required

Task ID

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • */*

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.39. List task logs

GET /api/v1/tasks/{taskId}/log
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
Type Name Description Schema

Path

taskId
required

Task ID

integer (int64)

Query

fields
optional

Comma-separated, case-sensitive top-level Task field names. Invalid field names will be ignored

string

Query

page
optional

Page number (from 1)

integer (int32)

Query

perPage
optional

Number of tasks per page

integer (int32)
Responses
HTTP Code Description Schema

200

OK

Task Log List Result

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.40. Get a task log

GET /api/v1/tasks/{taskId}/log/{taskLogId}
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
Type Name Description Schema

Path

taskId
required

Task ID

integer (int64)

Path

taskLogId
required

The Task Log ID

integer (int64)
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

500

Internal Server Error

Server Error Message
Produces

  • */*

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.41. Start a task

POST /api/v1/tasks/{taskId}/start
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
Type Name Description Schema

Path

taskId
required

The Task ID

string

Body

params
optional

The optional parameters consist of name value pairs posted in the request body.

< string, string > map
Responses
HTTP Code Description Schema

200

OK

Start Task Response

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • application/json

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.42. Stop a task

POST /api/v1/tasks/{taskId}/stop
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
Type Name Description Schema

Path

taskId
required

The Task ID

string

Body

nominalStart
required

The nominal start time of the task. It must be in the format yyyy-MM-dd hh:mm:ss.SS.

Stop Task Input
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Consumes

  • application/json

Produces

  • */*

Tags

  • Tasks

Security
Type Name Scopes

apiKey

accessToken

global

4.3.43. List user groups (2019.1 only)

GET /api/v1/usergroups
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
Type Name Description Schema

Query

fields
optional

Top-level, comma-separated case-sensitive field names. Invalid field names are ignored.

string

Query

name
optional

The search name. The name is case-insensitive. The wildcard character * can be used at the start or end of the search parameter.

string

Query

page
optional

Page number (start at page 1).

integer (int32)

Query

perPage
optional

Number of items per page.

integer (int32)

Query

type
optional

Search user groups by type. The types are 'local' or 'remote'. If the parameter is not specified, by default 'local' user groups are listed.

string
Responses
HTTP Code Description Schema

200

OK

ValueMapListResult«UserGroup»

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • User Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.3.44. Get user group (2019.1 only)

GET /api/v1/usergroups/{userGroupName}
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
Type Name Description Schema

Path

userGroupName
required

The User Group Name

string

Query

type
optional

Search user groups by type. The types are 'local' or 'remote'. If the parameter is not specified, by default 'local' user groups are listed.

string
Responses
HTTP Code Description Schema

200

OK

UserGroup

400

Bad Request

Error Message

401

Authentication Error

Error Message

403

Authorization Error

Error Message

404

Not Found

Error Message

409

Conflict

Server Error Message

422

Invalid Input

Validation Error Message

500

Internal Server Error

Server Error Message
Produces

  • application/json

Tags

  • User Groups

Security
Type Name Scopes

apiKey

accessToken

global

4.4. Definitions

4.4.1. AS1 Host

Name Description Schema

ClientCertSHA1
optional

Client certificate SHA1

string

ClientCertStore
optional

Client certificate store

string

ClientCertSubject
optional

Client certificate subject

string

DecryptCertSHA1
optional

Decryption certificate SHA1

string

DecryptCertStore
optional

Decryption certificate store

string

DecryptCertSubject
optional

Decryption certificate subject

string

DefCompressionFormat
optional

Default compression format

enum (None, ZLib)

DefEDIDataType
optional

Default EDI data type

enum (application/edi-x12, application/octet-stream, application/edi-consent, application/edifact, application/xml)

DefEncryptionAlgorithm
optional

Default encryption algorithm

enum (None, 3DES, DES, RC2, AES, AESCBC192, AESCBC256)

DefPartnerCertSHA1
optional

Default partner certificate SHA1

string

DefPartnerCertStore
optional

Default partner certificate store

string

DefPartnerCertSubject
optional

Default partner certificate subject

string

DefPartnerName
optional

Default partner name

string

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefSignatureAlgorithm
optional

Default signature algorithm

enum (sha1, md5, sha-224, sha-256, sha-384, sha-512)

DefSigningCertSHA1
optional

Default signing certificate SHA1

string

DefSigningCertStore
optional

Default signing certificate store

string

DefSigningCertSubject
optional

Default signing certificate subject

string

DeleteIfNewerThanDays
optional

Delete if newer than days

integer (int32)

DeleteIfOlderThanDays
optional

Delete if older than days

integer (int32)

Desc
optional

Description

string

FIPSOnly
optional

Whether to use FIPS only

enum (0, 1)

FirewallHostIP
optional

Firewall host IP

string

FirewallPassword
optional

Firewall password

string

FirewallPort
optional

Firewall port

integer (int32)

FirewallType
optional

Firewall type

enum (EMPTY, Tunnel, SOCKS4, SOCKS5)

FirewallUsername
optional

Firewall username

string

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

IgnoreCertProbs
optional

Ingnore certificate problems

enum (0, 1)

MDNPollCount
optional

MDN polling count

integer (int32)

MDNPollTimeoutSecs
optional

MDN polling timeout value in seconds

integer (int32)

Name
optional

Name of the object

string

OrgName
optional

Organization name

string

POPPort
optional

POP port

integer (int32)

POPServer
optional

POP server

string

Password
optional

Password

string

PauseRerunSecs
optional

Pause rerun seconds

integer (int32)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

SMTPAuthMethod
optional

SMTP authentication method

enum (None, Auth, CRAM-MD5)

SMTPPassword
optional

SMTP password

string

SMTPPort
optional

SMTP port

integer (int32)

SMTPServer
optional

SMTP server

string

SMTPUsername
optional

SMTP username

string

SSLStartMode
optional

SSL start mode

enum (None, Implicit, Explicit)

UseSMTPInfo
optional

Use SMTP information

enum (0, 1)

UseSigningCertForDecrypt
optional

Whether to use signing certificate for decryption

enum (0, 1)

Username
optional

Username

string

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.2. AS2 Host

Name Description Schema

AS1HostID
optional

AS1 host ID

string

ClientCertSHA1
optional

Client certificate SHA1

string

ClientCertStore
optional

Client certificate store

string

ClientCertSubject
optional

Client certificate subject

string

DMZHostID
optional

DMZ host ID

string

DecryptCertSHA1
optional

Decryption certificate SHA1

string

DecryptCertStore
optional

Decryption certificate store

string

DecryptCertSubject
optional

Decryption certificate subject

string

DefCompressionFormat
optional

Default compression format

enum (None, ZLib)

DefEDIDataType
optional

Default EDI data type

enum (application/edi-x12, application/octet-stream, application/edi-consent, application/edifact, application/xml)

DefEncryptionAlgorithm
optional

Default encryption algorithm

enum (None, 3DES, DES, RC2, AES, AESCBC192, AESCBC256)

DefPartnerCertSHA1
optional

Default partner certificate SHA1

string

DefPartnerCertStore
optional

Default partner certificate store

string

DefPartnerCertSubject
optional

Default partner certificate subject

string

DefPartnerName
optional

Default partner name

string

DefPartnerURL
optional

Partner URL

string

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefSignatureAlgorithm
optional

Default signature algorithm

enum (sha1, md5, sha-224, sha-256, sha-384, sha-512)

DefSigningCertSHA1
optional

Default signing certificate SHA1

string

DefSigningCertStore
optional

Default signing certificate store

string

DefSigningCertSubject
optional

Default signing certificate subject

string

Desc
optional

Description

string

FIPSOnly
optional

Whether to use FIPS only

enum (0, 1)

FirewallHostIP
optional

Firewall host IP

string

FirewallPassword
optional

Firewall password

string

FirewallPort
optional

Firewall port

integer (int32)

FirewallType
optional

Firewall type

enum (EMPTY, Tunnel, SOCKS4, SOCKS5)

FirewallUsername
optional

Firewall username

string

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

IgnoreCertProbs
optional

Ignore certificate problems

enum (0, 1)

MDNPollCount
optional

MDN polling count

integer (int32)

MDNPollTimeoutSecs
optional

MDN polling timeout value in seconds

integer (int32)

MailFrom
optional

Mail from

string

Name
optional

Name of the object

string

OrgName
optional

Organization name

string

Password
optional

Password

string

ProxyPassword
optional

Proxy password

string

ProxyPort
optional

Proxy port

integer (int32)

ProxySSL
optional

Proxy SSL

enum (Auto, Always, Never, Tunnel)

ProxyServer
optional

Proxy server

string

ProxyServerType
optional

Proxy server type

enum (None, Default, Specific)

ProxyUsername
optional

Proxy username

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

SMTPServer
optional

SMTP server

string

UseHTTPAuth
optional

Use HTTP authentication

enum (0, 1)

UseSigningCertForDecrypt
optional

Whether to use signing certificate for decryption

enum (0, 1)

Username
optional

Username

string

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.3. AS3 Host

Name Description Schema

ClientCertSHA1
optional

Client certificate SHA1

string

ClientCertStore
optional

Client certificate store

string

ClientCertSubject
optional

Client certificate subject

string

DecryptCertSHA1
optional

Decryption certificate SHA1

string

DecryptCertStore
optional

Decryption certificate store

string

DecryptCertSubject
optional

Decryption certificate subject

string

DefCompressionFormat
optional

Default compression format

enum (None, ZLib)

DefEDIDataType
optional

Default EDI data type

enum (application/edi-x12, application/octet-stream, application/edi-consent, application/edifact, application/xml)

DefEncryptionAlgorithm
optional

Default encryption algorithm

enum (None, 3DES, DES, RC2, AES, AESCBC192, AESCBC256)

DefPartnerCertSHA1
optional

Default partner certificate SHA1

string

DefPartnerCertStore
optional

Default partner certificate store

string

DefPartnerCertSubject
optional

Default partner certificate subject

string

DefPartnerName
optional

Default partner name

string

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefSignatureAlgorithm
optional

Default signature algorithm

enum (sha1, md5, sha-224, sha-256, sha-384, sha-512)

DefSigningCertSHA1
optional

Default signing certificate SHA1

string

DefSigningCertStore
optional

Default signing certificate store

string

DefSigningCertSubject
optional

Default signing certificate subject

string

Desc
optional

Description

string

FIPSOnly
optional

Whether to use FIPS only

enum (0, 1)

FirewallHostIP
optional

Firewall host IP

string

FirewallPassword
optional

Firewall password

string

FirewallPort
optional

Firewall port

integer (int32)

FirewallType
optional

Firewall type

enum (EMPTY, Tunnel, SOCKS4, SOCKS5)

FirewallUsername
optional

Firewall username

string

Group
optional

Groups the object belongs to

< string > array

Host
optional

Host

string

ID
optional

ID of the object

string

IgnoreCertProbs
optional

Ignore certificate problems

enum (0, 1)

MDNPollCount
optional

MDN polling count

integer (int32)

MDNPollTimeoutSecs
optional

MDN polling timeout value in seconds

integer (int32)

Name
optional

Name of the object

string

OrgName
optional

Organization name

string

Passive
optional

Passive

enum (0, 1)

Password
optional

Password

string

PauseRerunSecs
optional

Pause rerun seconds

integer (int32)

Port
optional

Port

integer (int32)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

Secure
optional

How to encrypt the connection

enum (None, Implicit, Explicit)

UseSigningCertForDecrypt
optional

Whether to use signing certificate for decryption

enum (0, 1)

Username
optional

Username

string

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.4. About Info

Name Description Schema

appBuildNumber
optional

MOVEit Automation Web Admin build number

string

appBuildTimestamp
optional

MOVEit Automation Web Admin build timestamp

string

appVersion
optional

MOVEit Automation Web Admin version

string

centralApiVersion
optional

MOVEit Automation server API version

string

centralHost
optional

MOVEit Automation server host

string

centralVersion
optional

MOVEit Automation server version

string

isAdmin
optional

Authenticated as admin
Example : false

boolean

license
optional

Information about licensing

License

serverTimezoneInfo
optional

Information about server timezone

Server Timezone Info

username
optional

Username

string

4.4.5. Access Control List

Name Description Schema

ACLID
optional

ACL Id
Example : "12345"

string

Permissions
optional

Permissions

Permissions

ResourceGroupName
optional

Resource Group Name
Example : "Example resource group name"

string

UserGroupName
optional

User Group Name
Example : "Example user group name"

string

4.4.6. Access Control List Result

Name Description Schema

items
required

List of ACLs

< Access Control List > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.7. And Type

Name Description Schema

comp
required

comp

< Comp Type > array

4.4.8. Audit Report

Name Description Schema

items
required

List of audit log records

< Audit Report Record > array

sorting
optional

Sorting information

< Sorting Field > array

4.4.9. Audit Report Record

Name Description Schema

Action
optional

Action

string

AgentBrand
optional

Agent brand

string

AgentVersion
optional

Agent version

string

CentralVersion
optional

Central version

string

ClientIP
optional

Client IP address

string

Hash
optional

Hash

string

IPAddress
optional

IP address

string

LogID
optional

Log ID

integer (int32)

LogTime
optional

Log time

string (date-time)

Node
optional

Node

integer (int32)

QueryType
optional

Query type

string

Status
optional

Status

string

StatusCode
optional

Status code

integer (int32)

StatusMsg
optional

Status message

string

TargetID
optional

Target ID

string

TargetType
optional

Target type

string

TaskName
optional

Task name

string

Username
optional

Username

string

4.4.10. Choices

Name Description Schema

Choice
optional

List of choices

< string > array

4.4.11. Comp Type

Name Description Schema

a
required

Lefthand operand

string

b
required

Righthand operand

string

test
required

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, NEQ, NNE, NGT, NGE, NLT, NLE, MASK, NOTMASK)

4.4.12. Criteria Type

Name Description Schema

And
optional

And

And Type

Or
optional

Or

Or Type

comp
optional

comp

Comp Type

4.4.13. Custom Script

Name Description Schema

Description
optional

Description

string

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

Lang
optional

Script language

enum (VBScript, PS1)

Name
optional

Name of the object

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

Source
optional

Source

string

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.14. Custom Script List Result

Name Description Schema

items
required

List of custom scripts

< Custom Script > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.15. Date List

Name Description Schema

Description
optional

Description

string

Entries
optional

Array of single element json objects containing either {"C": "Comment Value"} or {"Date": "yyyy-mm-dd"}

< > array

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

Name
optional

Name of the object

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.16. Date List Reference

Name Description Schema

ID
optional

ID of the date list

string

Run
required

Whether to run

enum (0, 1)

value
optional

Value

string

4.4.17. Date List, List Result

Name Description Schema

items
required

List of date lists

< Date List > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.18. Days

Name Description Schema

DayOfMonth
optional

Days of month
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (byte)

DayOfWeek
optional

Days of week

< enum (Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday) > array

4.4.19. Destination Step

Name Description Schema

AB
optional

ASCII vs binary transfer mode; applies only to FTP

enum (ascii, binary)

Account
optional

The account to use during authentication; for FTP only. Rarely used.

string

AddCom
optional

Commands to execute (per file) before transfer; applies only to FTP

string

AddComAX
optional

Commands to execute (per file) after transfer; applies only to FTP

string

AddressTo
optional

Email address for SMTP destinations

string

BlindDL
optional

Blind download enabled: if enabled, no directory listing is done prior to download

enum (0, 1)

BlindUL
optional

Whether to do blind upload

enum (0, 1)

Bucket
optional

S3 bucket name; for AWS S3 only

string

ClientCertSHA1
optional

Client certificate SHA1

string

ClientCertStore
optional

Client certificate store

string

ClientCertSubject
optional

Client certificate subject

string

ClientKeyID
optional

Client key ID

string

ConnTimeoutSecs
optional

Connection timeout seconds
Minimum value : 0
Maximum value : 32000

integer (int32)

DataTimeoutSecs
optional

Data timeout in seconds
Minimum value : 0
Maximum value : 32000

integer (int32)

DestFileAttr
optional

Destination file attribute

string

FileName
optional

Destination filename

string

FolderID
optional

MOVEit Transfer folder ID

string

FolderName
optional

Folder name

string

FolderType
optional

Folder type; rarely-used setting that applies only to MOVEit Transfer hosts

enum (-1, 1, 4, 10, 110, 19, 119, 99)

ForceDir
optional

Force directory if it does not already exist

enum (0, 1)

HostID
optional

ID of associated host

string

ID
optional

ID

string

MD5File
optional

Filename of the MD5SUM file; used only by FTP and SFTP

string

MD5Get
optional

Whether to process MD5SUM files

enum (IfPresent, Required, Never)

MDNEmail
optional

MDN email recipient, for AS/1 destinations

string

MDNFileMaskToPoll
optional

MDN file mask to poll

string

MDNPath
optional

Path of the Message Disposition Notification; used only by AS/x

string

MDNURL
optional

URL to which the AS/x MDN should be sent

string

MailSubject
optional

AS/x email subject

string

Message
optional

The body of the email message to send

string

MultipleAttachments
optional

Whether an AS/x destination should attach multiple files to a single message

enum (0, 1)

MxBy
optional

Maximum number of bytes per task run
Minimum value : 0

integer (int64)

MxFi
optional

Maximum number of files per task run
Minimum value : 0
Maximum value : 99999

integer (int32)

OverwriteOrig
optional

What to do if the destination filename already exists

enum (0, 1, 2)

Passive
optional

Whether to use passive mode; used only by FTP

enum (0, 1)

Password
optional

Password

string

Path
optional

Folder path of the source or destination

string

RequestAsyncMDN
optional

Whether to request an async MDN

enum (0, 1)

RequestMDN
optional

Whether an MDN should be requested

enum (0, 1)

RequestSigned
optional

Whether request should be signed

enum (0, 1)

RescanSecs
optional

Rescan in seconds
Minimum value : 0
Maximum value : 999

integer (int32)

RetryCount
optional

Retry count
Minimum value : 0
Maximum value : 32000

integer (int32)

RetryIfNoFiles
optional

Whether to rescan for files if none were found

enum (0, 1)

RetryTimeoutSecs
optional

Retry timeout in seconds
Minimum value : 0
Maximum value : 32000

integer (int32)

ReuseSSL
optional

Whether to reuse SSL sessions; for FTP only

enum (0, 1)

Rsm
optional

Whether to attempt resume of transfers; 0 means no and 1 means yes

integer (int32)

SearchSubdirs
optional

Whether to search subdirectories

enum (0, 1)

SetFileAttr
optional

Whether to set file attributes after upload, if UseDefSetFileAttr is false

enum (0, 1)

Sort
optional

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, Size,A, Filename,A, Date,D, Size,D, Filename,D)

Subject
optional

Email subject

string

Type
optional

The host type of this step

enum (siLock, FTP, SSHFTP, FileSystem, SMTP, Share, POP3, S3, AS1, AS2, AS3)

UDMxBy
optional

Use the host’s default maximum bytes

enum (0, 1)

UDMxFi
optional

Use the host’s default maximum files

enum (0, 1)

UseDefAB
optional

Use the host’s default ASCII vs binary; applies only to FTP

enum (0, 1)

UseDefBlindDL
optional

Use the host’s default blind download setting

enum (0, 1)

UseDefBlindUL
optional

Use default blind upload

enum (0, 1)

UseDefBucket
optional

Whether to use the host’s default bucket; for S3 only

enum (0, 1)

UseDefClientCert
optional

Use the host’s default client certificate

enum (0, 1)

UseDefClientKey
optional

Use the host’s default client key

enum (0, 1)

UseDefConnTimeoutSecs
optional

Use the host’s default connection timeout in seconds

enum (0, 1)

UseDefDataTimeoutSecs
optional

Use the host’s default data timeout in seconds

enum (0, 1)

UseDefMD5File
optional

Use the host’s default MD5 file

enum (0, 1)

UseDefMD5Get
optional

Use the host’s default setting for whether to process MD5SUM files

enum (0, 1)

UseDefPartner
optional

Use default partner

enum (0, 1)

UseDefPassive
optional

Use the host’s default passive

enum (0, 1)

UseDefRescanSecs
optional

Use the host’s default rescan seconds

enum (0, 1)

UseDefRetryCount
optional

Use the host’s default retry count

enum (0, 1)

UseDefRetryTimeoutSecs
optional

Use the host’s default retry timeout in seconds

enum (0, 1)

UseDefReuseSSL
optional

Use the host’s default reuse SSL; for FTP only

enum (0, 1)

UseDefRsm
optional

Use the host’s default resume of file transfers

enum (0, 1)

UseDefSetFileAttr
optional

Use the host’s default set file attribute

enum (0, 1)

UseDefSort
optional

Use the host’s default sort

enum (0, 1)

UseDefUser
optional

Use the host’s default user

enum (0, 1)

UseDefWinCopyFileAPI
optional

Use the host’s default Windows copy file API setting

enum (0, 1)

UseDefXS
optional

Use the host’s default setting whether to check integrity via XSHA1. For FTP only.

enum (0, 1)

UseEncryptionCert
optional

Whether an encryption certificate should be used

enum (0, 1)

UseOrigName
optional

Use original filename on destination

enum (0, 1)

UseRelativeSubdirs
optional

Use relative subdirectories

enum (0, 1)

UseWinCopyFileAPI
optional

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
optional

Username

string

VerificationCertSHA1
optional

Verification certificate SHA1

string

VerificationCertStore
optional

Verification certificate store

string

VerificationCertSubject
optional

Verification certificate subject

string

XS
optional

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.

string

Zip
optional

Whether to zip the file

enum (0, 1)

4.4.20. Email Step

Name Description Schema

AddressTo
optional

Email address

string

HostID
optional

ID of the SMTP host

string

ID
optional

ID

string

Message
optional

Body of the email to send

string

Subject
optional

Subject of the email to send

string

Type
optional

This setting is not used

string

UseDefConnTimeoutSecs
optional

Use default connection timeout in seconds

enum (0, 1)

UseDefDataTimeoutSecs
optional

Use default data timeout in seconds

enum (0, 1)

UseDefRetryCount
optional

Use default retry count

enum (0, 1)

UseDefRetryTimeoutSecs
optional

Use default retry timeout in seconds

enum (0, 1)

4.4.21. Error Message

Name Description Schema

detail
required

An explanation specific to this occurrence of the error

string

status
required

The HTTP status code generated by the origin server for this occurrence of the error

integer (int32)

title
required

A short summary of the error type

string

4.4.22. FTP Host

Name Description Schema

AddCom
optional

Commands to execute (per file) before transfer

string

AddComAX
optional

Commands to execute (per file) after transfer

string

AddComSignon
optional

Commands to execute upon signon

string

AdjDST
optional

Account for daylight savings

enum (0, 1)

AuthOrder
optional

Authentication order

string

CustomDir
optional

Custom directory parsing enabled

enum (0, 1)

CustomDirColDate
optional

Custom directory column for date

integer (int32)

CustomDirColFilename
optional

Custom directory column for filename

integer (int32)

CustomDirSkipBottom
optional

Custom directory lines to skip at bottom

integer (int32)

CustomDirSkipTop
optional

Custom directory lines to skip at top

integer (int32)

DataTimeout
optional

Data timeout

string

DefAB
optional

Default ASCII vs binary transfer mode

enum (ascii, binary)

DefAccount
optional

Default account

string

DefAddressFrom
optional

Address from

string

DefBlindDL
optional

Default blind download enabled

enum (0, 1)

DefBlindUL
optional

Default blind upload enabled

enum (0, 1)

DefClientCertSHA1
optional

Default client certificate SHA1

string

DefClientCertStore
optional

Default client certificate store

string

DefClientCertSubject
optional

Default client certificate subject

string

DefClientKeyID
optional

Default client key ID

string

DefConnTimeoutSecs
optional

Default connection timeout in seconds

integer (int32)

DefDataTimeoutSecs
optional

Default data timeout in seconds

integer (int32)

DefMD5File
optional

Default MD5SUM filename

string

DefMD5Get
optional

Default whether to process MD5SUM files

enum (IfPresent, Required, Never)

DefMxBy
optional

Default maximum number of bytes per task run

integer (int64)

DefMxFi
optional

Default maximum number of files per task run

integer (int32)

DefPassive
optional

Default whether to use passive mode

enum (0, 1)

DefPassword
optional

Default password

string

DefRescanSecs
optional

Default rescan seconds

integer (int32)

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefReuseSSL
optional

Reuse SSL for data connections

enum (0, 1)

DefRsm
optional

Default whether to resume failed transfers

string

DefSort
optional

Default sorting order

enum (Date,A, Size,A, Filename,A, Date,D, Size,D, Filename,D)

DefUsername
optional

Default username

string

DefXS
optional

Default flag for whether to do XSHA1 if available

enum (0, 1)

DelOldStateDays
optional

Delete file stamp state entries after this many days (0=never)

integer (int32)

Desc
optional

Description

string

DirScriptID
optional

ID of directory parsing script

string

DotNET
optional

Ignored for FTP

enum (0, 1)

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

ID2
optional

ID of secondary host

string

IgnoreCertProbs
optional

Ignore certificate problems

enum (0, 1)

Name
optional

Name of the object

string

NatClientIP
optional

NAT client IP address

string

NatUseServerIPForData
optional

NAT use server IP address for data

enum (0, 1)

PASVWS
optional

Number of seconds to wait before connecting to passive port

integer (int32)

ProxyHost
optional

Proxy host

string

ProxyPassword
optional

Proxy password

string

ProxyPort
optional

Proxy port

integer (int32)

ProxyType
optional

Proxy type: one of None, SOCKS5

string

ProxyUsername
optional

Proxy username

string

RenameAfterUpload
optional

Whether to rename after upload

enum (0, 1)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

ReuseSSLSession
optional

Reuse SSL session

enum (0, 1)

SSHFingerprint
optional

Fingerprint of SSH server key

string

ScriptPath
optional

Script path

string

Secure
optional

Session encryption type, one of: none, tls-p, tls-p-ccc, tls-c , tls-c-ccc, implicit, implicit-ccc

string

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

TempUploadName
optional

Temporary upload name

string

UTCOffset
optional

Offset from GMT, in seconds - used only by sync tasks

integer (int32)

UseDefStateCaching
optional

Use default state caching

enum (0, 1)

UseNotif
optional

Not used for this host type

enum (0, 1)

host
optional

Host

string

port
optional

Port

integer (int32)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.23. File Activity Report

Name Description Schema

items
required

List of file activity report records

< File Activity Report Record > array

sorting
optional

Sorting information

< Sorting Field > array

4.4.24. File Activity Report Record

Name Description Schema

Action
optional

Action

string

DestASxMDN
optional

Destination AS1/AS2/AS3 MDN

string

DestASxMsgID
optional

Destination AS1/AS2/AS3 message ID

string

DestBytes
optional

Destination byte count

number (double)

DestDuration
optional

Destination duration in seconds

number (double)

DestFile
optional

Destination file

string

DestFileID
optional

Destination file ID

string

DestHost
optional

Destination host

string

DestPath
optional

Destination path

string

LogID
optional

Log ID

integer (int64)

LogStamp
optional

Log timestamp

string (date-time)

Node
optional

Node ID

integer (int32)

NominalStart
optional

Nominal start time

string

QueryType
optional

Query type

string

ScheduledTime
optional

Scheduled time

string (date-time)

SourceASxMDN
optional

Source AS1/AS2/AS3 MDN

string

SourceASxMsgID
optional

Source AS1/AS2/AS3 message ID

string

SourceBytes
optional

Source byte count

number (double)

SourceDuration
optional

Source duration in seconds

number (double)

SourceFile
optional

Source file

string

SourceFileID
optional

Source file ID

string

SourceHost
optional

Source host

string

SourcePath
optional

Source path

string

SourceStamp
optional

Source timestamp (usually modified timestamp)

string

StartTime
optional

Start time

string (date-time)

Status
optional

Status

string

StatusCode
optional

Numeric error code (or 0 if no error)

integer (int32)

StatusMsg
optional

Error or status message

string

TaskID
optional

Task ID

integer (int32)

TaskName
optional

Task name

string

TransferBytes
optional

Transfer bytes

number (double)

4.4.25. File System Share

Name Description Schema

AdjDST
optional

Whether host adjusts for DST

enum (0, 1)

DriveLetter
optional

Drive letter

string

Password
optional

Password

string

UNC
optional

UNC

string

UseNotif
optional

Use filesystem notifications

enum (0, 1)

Username
optional

Username

string

4.4.26. FileSystem Host

Name Description Schema

AdjDST
optional

Account for daylight savings

enum (0, 1)

DefMxBy
optional

Default maximum number of bytes per task run

integer (int64)

DefMxFi
optional

Default maximum number of files per task run

integer (int32)

DefRescanSecs
optional

Rescan period

integer (int32)

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DelOldStateDays
optional

Delete file stamp state entries after this many days (0=never)

integer (int32)

Desc
optional

Description

string

Group
optional

Groups the object belongs to

< string > array

Host
optional

Hostname

string

ID
optional

ID of the object

string

ID2
optional

ID of secondary host

string

Name
optional

Name of the object

string

Port
optional

Port number

integer (int32)

RenameAfterUpload
optional

Whether to rename after upload

enum (0, 1)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

Share
optional

Collection of file system shares

< File System Share > array

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

TempUploadName
optional

Temporary upload name

string

UTCOffset
optional

Offset from GMT, in seconds - used only by sync tasks

integer (int32)

UseDefStateCaching
optional

Use state caching

enum (0, 1)

UseNotif
optional

Use filesystem notifications

enum (0, 1)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.27. For Step

Name Description Schema

ID
optional

ID

string

steps
optional

Steps included in this for step. The type can be destination, email, for, if, process, runtask, source, updorig and when

< object > array

4.4.28. Frequency

Name Description Schema

Interval
optional

List of intervals

< Interval > array

4.4.29. Global Parameter

Name Description Schema

CountedDisplayValue
optional

Counted display value of the global parameter

string

DisplayValue
optional

Display value of the global parameter

string

Name
optional

Name of the global parameter

string

Value
optional

Value of the global parameter

string

4.4.30. GlobalParameter, List Result

Name Description Schema

items
required

List of global parameters

< Global Parameter > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.31. Host List Result

Name Description Schema

items
required

List of host objects

< 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 > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

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

Name Description Schema

AS1
optional

AS1 host

AS1 Host

AS2
optional

AS2 host

AS2 Host

AS3
optional

AS3 host

AS3 Host

FTP
optional

FTP host

FTP Host

FileSystem
optional

Filesystem host

FileSystem Host

POP3
optional

POP3 host

POP3 Host

S3
optional

S3 host

S3 Host

SMTP
optional

SMTP host

SMTP Host

SSHFTP
optional

SSHFTP host

SSHFTP Host

Share
optional

Share host

Share Host

SiLock
optional

MOVEit Transfer host

MOVEit Transfer Host

4.4.33. If Step

Name Description Schema

ID
optional

ID

string

Otherwise
optional

The steps to take if the condition is false

Otherwise Step

When
required

The condition to test, and the steps to take if it is true

< When Step > array

4.4.34. Information

Name Description Schema

Description
required

Description of the configuration item

string

Notes
required

Notes of the configuration item

string

4.4.35. Interval

Name Description Schema

EndTime
required

End time, in the format HH:MM

string

EveryMinutes
required

The interval between task runs, in minutes.

integer (int32)

ID
optional

ID of the interval

string

StartTime
required

Start time, in the format HH:MM

string

value
optional

This property is not used

string

4.4.36. License

Name Description Schema

acctMgtLicensed
optional

Account management licensed

enum (0, 1)

advTasksLicensed
optional

Advanced tasks licensed

enum (0, 1)

apiLicensed
optional

API licensed

enum (0, 1)

as2Licensed
optional

AS2 licensed

enum (0, 1)

backupHostsLicensed
optional

Backup hosts licensed

enum (0, 1)

customScriptsLicensed
optional

Custom scripts licensed

enum (0, 1)

maxHosts
optional

Max hosts

integer (int64)

maxTasks
optional

Max tasks

integer (int64)

pgpLicensed
optional

PGP licensed

enum (0, 1)

resilEnabled
optional

Resil enabled

enum (0, 1)

resilRole
optional

Resil role

string

version
optional

Version

string

4.4.37. MOVEit Transfer Host

Name Description Schema

AddCom
optional

Add com

string

AddComSignon
optional

Add com signon

string

AdjDST
optional

Account for daylight savings

enum (0, 1)

CustomDir
optional

Custom directory

enum (0, 1)

CustomDirColDate
optional

Custom directory col date

integer (int32)

CustomDirColFilename
optional

Custom directory col filename

integer (int32)

CustomDirSkipBottom
optional

Custom directory skip bottom

integer (int32)

CustomDirSkipTop
optional

Custom directory skip top

integer (int32)

DefAB
optional

AB

enum (ascii, binary)

DefAccount
optional

Account

string

DefAddressFrom
optional

From address

string

DefBlindDL
optional

Blind DL

enum (0, 1)

DefBlindUL
optional

Blind UL

enum (0, 1)

DefClientCertSHA1
optional

Client certificate SHA1

string

DefClientCertStore
optional

Client certificate store

string

DefClientCertSubject
optional

Client certificate subject

string

DefClientKeyID
optional

Client key ID

string

DefConnTimeoutSecs
optional

Connection timeout in seconds

integer (int32)

DefDataTimeoutSecs
optional

Default data timeout in seconds

integer (int32)

DefMD5File
optional

Default MD5SUM filename

string

DefMD5Get
optional

Default whether to process MD5SUM files

enum (IfPresent, Required, Never)

DefMxBy
optional

Default maximum number of bytes per task run

integer (int64)

DefMxFi
optional

Default maximum number of files per task run

integer (int32)

DefPassive
optional

Passive

enum (0, 1)

DefPassword
optional

Password

string

DefRescanSecs
optional

Default rescan seconds

integer (int32)

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefSort
optional

Sort

enum (Date,A, Size,A, Filename,A, Date,D, Size,D, Filename,D)

DefUsername
optional

Username

string

DelOldStateDays
optional

Delete file stamp state entries after this many days (0=never)

integer (int32)

Desc
optional

Description

string

DotNET
optional

Whether target host uses .NET (should always be 1)

enum (0, 1)

Group
optional

Groups the object belongs to

< string > array

Host
optional

Host

string

ID
optional

ID of the object

string

ID2
optional

ID of secondary host

string

IgnoreCertProbs
optional

Ignore certificate problems

enum (0, 1)

NATUseServerIPForData
optional

NAT use server IP for data

enum (0, 1)

Name
optional

Name of the object

string

Port
optional

Port

integer (int32)

RenameAfterUpload
optional

Whether to rename after upload

enum (0, 1)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

SSHFingerprint
optional

SSH finger print

string

ScriptPath
optional

Script path

string

Secure
optional

Whether to encrypt the connection

string

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

TempUploadName
optional

Temporary upload name

string

UseDefStateCaching
optional

Use state caching

enum (0, 1)

UseNotif
optional

Use filesystem notifications

enum (0, 1)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.38. MicSshKeyTypeListResultModel

Name Description Schema

items
required

List of SSH keys

< Ssh Key > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.39. Next Action

Name Description Schema

AddressTo
optional

Email address to which mail should be sent, if Type is Email

string

DoAfter
optional

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.

string

DoIfFailure
optional

Do this when failed

enum (0, 1)

DoIfNoAction
optional

Do this when no action

enum (0, 1)

DoIfSuccess
optional

Do this when succeeded

enum (0, 1)

HostID
optional

The ID of the SMTP host to use, if Type is Email

string

ID
optional

ID of the next action

string

Message
optional

The body of the email message, if Type is Email

string

Parameters
optional

Parameters to pass to the task, if Type is Task

Parameters

Subject
optional

The subject of the email message, if Type is Email

string

TaskID
optional

The ID of the task to run, if Type is Task

string

Type
optional

Type of the next action. A value of "Email" means send an email. A value of "Task" means run a task.

string

4.4.40. Next actions

Name Description Schema

NextAction
optional

List of actions to take next

< Next Action > array

4.4.41. Or Type

Name Description Schema

comp
required

comp

< Comp Type > array

4.4.42. Otherwise Step

Name Description Schema

steps
optional

Steps included in this Otherwise Step. The type can be Destination, Email, For, If, Process, RunTask, Source, UpdOrig and When

< object > array

4.4.43. PGP Key

Name Description Schema

Created
optional

Created

string

Disabled
optional

Disabled

enum (0, 1)

Expired
optional

Expired

enum (0, 1)

Expires
optional

Expires

string

Fingerprint
optional

Fingerprint

string

ID
required

ID

string

KeyLength
optional

Key length

string

KeyType
optional

Key type

string

Name
optional

Name

string

PubPriv
optional

"pub" for public component only, or "pair" for keypair

string

Revoked
optional

Revoked

enum (0, 1)

Status
optional

Status

string

SymAlg
required

Symmetric algorithm

string

uid
optional

UID (user ID) of key

string

xAddEditDelete
optional

Add edit delete permission, readonly
Example : false

boolean

4.4.44. PGP Key List Result

Name Description Schema

items
required

List of PGP key objects

< PGP Key > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.45. POP3 Host

Name Description Schema

DefConnTimeoutSecs
optional

Connection timeout in seconds

integer (int32)

DefDataTimeoutSecs
optional

Default data timeout in seconds

integer (int32)

DefPassword
optional

Password

string

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefUsername
optional

Username

string

DelOldStateDays
optional

Delete file stamp state entries after this many days (0=never)

integer (int32)

Desc
optional

Description

string

Group
optional

Groups the object belongs to

< string > array

Host
optional

Host

string

ID
optional

ID of the object

string

ID2
optional

ID of secondary host

string

Name
optional

Name of the object

string

Port
optional

Port

integer (int32)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

UseDefStateCaching
optional

Use state caching

enum (0, 1)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.46. Paging Information

Name Description Schema

page
required

Page number

integer (int32)

perPage
required

Number of objects per page

integer (int32)

totalItems
required

Total number of objects in the entire result set

integer (int32)

totalPages
required

Total number of pages in the entire result set

integer (int32)

4.4.47. Parameter

Name Description Schema

Choices
optional

Choices

Choices

Default
optional

Default value

string

InOut
optional

Contains values either In or Out

string

ParamDesc
optional

Parameter description

string

ParamName
optional

Parameter name

string

Required
optional

Is required
Example : false

boolean

Type
optional

Parameter type

string

4.4.48. Parameters

Name Description Schema

any
optional

List of parameters

< object > array

4.4.49. Permissions

Name Description Schema

HostAddEditDelete
optional

Add/edit/delete hosts
Example : "0"

enum (0, 1)

PGPAddEditDelete
optional

Add/edit/delete PGP keys
Example : "0"

enum (0, 1)

SSHAddEditDelete
optional

Add/edit/delete SSH keys
Example : "0"

enum (0, 1)

SSLAddEditDelete
optional

Add/edit/delete SSL certs
Example : "0"

enum (0, 1)

ScriptAddEditDelete
optional

Add/edit/delete scripts
Example : "0"

enum (0, 1)

TaskAddEditDelete
optional

Add/edit/delete tasks
Example : "0"

enum (0, 1)

TaskEditExisting
optional

Edit existing elements of the tasks
Example : "0"

enum (0, 1)

TaskRun
optional

Run tasks
Example : "0"

enum (0, 1)

4.4.50. Process Step

Name Description Schema

ID
optional

ID

string

IsDest
optional

Whether this script should be regarded as acting like a destination

enum (0, 1)

Parameters
optional

Task parameters specific to this process

Parameters

Run
optional

When the process should run

enum (Once, PerFile)

ScriptID
required

ID of script to run

string

4.4.51. Report Query Input

Name Description Schema

maxCount
required

Maximum number of entries to return, must be in the range of 1 to 100,000

integer (int32)

orderBy
required

Report result sorting order specified with comma-separated case-insensitive column names which can be optionally prefixed with ! for descending order

string

predicate
required

Selection criteria using RSQL language to filter reporting data

string

4.4.52. Resource Group

Name Description Schema

Members
optional

Members of the resource group

< Resource Group Member > array

Name
optional

Name of the resource group

string

Notes
optional

Description of the resource group

string

xAddHost
optional

True if the current user can add hosts to this resource group
Example : false

boolean

xAddPGPKey
optional

True if the current user can add PGP keys to this resource group
Example : false

boolean

xAddSSHClientKey
optional

True if the current user can add SSH client keys to this resource group
Example : false

boolean

xAddSSLCert
optional

True if the current user can add SSL certs to this resource group
Example : false

boolean

xAddScript
optional

True if the current user can add scripts to this resource group
Example : false

boolean

xAddTask
optional

True if the current user can add tasks to this resource group
Example : false

boolean

4.4.53. Resource Group List Result

Name Description Schema

items
required

List of resource groups

< Resource Group > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.54. Resource Group Member

Name Description Schema

t
optional

Type of the member

enum (task, host, script, ssl, ssh, pgp)

value
optional

ID of the member

string

4.4.55. Run Task Step

Name Description Schema

ID
optional

ID

string

TaskID
required

TaskID

string

Wait
optional

Whether to wait until target task is complete before running

enum (0, 1)

items
optional

This setting is not used

< object > array

4.4.56. Running Task

Name Description Schema

CurFileBytes
optional

Current position in file

integer (int64)

LastErrorText
optional

Text description of the last error

string

LastErrorType
required

Type of the last error

integer (int32)

NominalStart
required

Nominal start of the running task

string

StartedBy
required

Username of the user who started the running task

string

Status
required

Current status of the running task

string

StopRequested
required

0 means the running task has not been requested to stop

enum (0, 1)

TaskID
required

Id of the running task

string

TaskName
required

Name of the running task

string

TimeStarted
required

Start time of the running task

string

TotFileBytes
optional

Total number of bytes in the file

integer (int64)

xAddEditDelete
optional

True if the current user can add, edit or delete the running task
Example : false

boolean

xAlter
optional

True if the current user can alter the running task
Example : false

boolean

xRun
optional

True if the current user can run the running task
Example : false

boolean

4.4.57. Running Task List Result

Name Description Schema

items
required

List of running task objects

< Running Task > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.58. S3 Host

Name Description Schema

AdjDST
optional

Account for daylight savings

enum (0, 1)

DefBucket
optional

Default bucket

string

DefConnTimeoutSecs
optional

Connection timeout seconds

integer (int32)

DefDLInteg
optional

Default download integrity checking; one of never, ifsure, ignore, always

string

DefDataTimeoutSecs
optional

Default data timeout in seconds

integer (int32)

DefMxBy
optional

Default maximum number of bytes per task run

integer (int32)

DefMxFi
optional

Default maximum number of files per task run

integer (int32)

DefPassword
optional

Default secret access key

string

DefRescanSecs
optional

Default rescan seconds

integer (int32)

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefUsername
optional

Default access key id

string

DelOldStateDays
optional

Delete file stamp state entries after this many days (0=never)

integer (int32)

Desc
optional

Description

string

Group
optional

Groups the object belongs to

< string > array

Host
optional

Host

string

ID
optional

ID of the object

string

Name
optional

Name of the object

string

Port
optional

Port

integer (int32)

ProxyHost
optional

Proxy host

string

ProxyPassword
optional

Proxy password

string

ProxyPort
optional

Proxy port

integer (int32)

ProxyType
optional

Proxy type: one of none, HTTP, or HTTPS

string

ProxyUsername
optional

Proxy username

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

Secure
optional

Whether to encrypt the connection

enum (0, 1)

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

UseDefStateCaching
optional

Use state caching

enum (0, 1)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.59. SMTP Host

Name Description Schema

DefAddressFrom
optional

From address

string

DefConnTimeoutSecs
optional

Connection timeout in seconds

integer (int32)

DefDataTimeoutSecs
optional

Default data timeout in seconds

integer (int32)

DefPassword
optional

Password

string

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefUsername
optional

Username

string

Desc
optional

Description

string

Group
optional

Groups the object belongs to

< string > array

Host
optional

Host

string

ID
optional

ID of the object

string

ID2
optional

ID of secondary host

string

IgnoreCertProbs
optional

Ignore certificate problems

enum (0, 1)

Name
optional

Name of the object

string

Port
optional

Port

integer (int32)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

Secure
optional

Whether to encrypt the connection

string

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

UseDefStateCaching
optional

Use state caching

enum (0, 1)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.60. SSHFTP Host

Name Description Schema

AddCom
optional

Add com

string

AddComAX
optional

Add com AX

string

AddComSignon
optional

Add com signon

string

AdjDST
optional

Account for daylight savings

enum (0, 1)

CmpL
optional

Compression level, 0 - disable compression, 6 - enable compression

enum (0, 6)

CustomDir
optional

Custom directory

enum (0, 1)

CustomDirColDate
optional

Custom directory date column

integer (int32)

CustomDirColFilename
optional

Custom directory filename column

integer (int32)

CustomDirSkipBottom
optional

Custom directory lines to skip at bottom

integer (int32)

CustomDirSkipTop
optional

Custom directory lines to skip at top

integer (int32)

DefAB
optional

AB

enum (ascii, binary)

DefAccount
optional

Account

string

DefAddressFrom
optional

From address

string

DefBlindDL
optional

Blind downloads

enum (0, 1)

DefBlindUL
optional

Blind uploads

enum (0, 1)

DefClientCertSHA1
optional

Client certificate SHA1

string

DefClientCertStore
optional

Client certificate store

string

DefClientCertSubject
optional

Client certificate subject

string

DefClientKeyID
optional

Default client key ID

string

DefConnTimeoutSecs
optional

Connection timeout in seconds

integer (int32)

DefDataTimeoutSecs
optional

Default data timeout in seconds

integer (int32)

DefDestFileAttr
optional

Destination UNIX file attributes as an octal number

string

DefMD5File
optional

Default MD5SUM filename

string

DefMD5Get
optional

Default whether to process MD5SUM files

enum (IfPresent, Required, Never)

DefMxBy
optional

Default maximum number of bytes per task run

integer (int64)

DefMxFi
optional

Default maximum number of files per task run

integer (int32)

DefPassive
optional

Passive

enum (0, 1)

DefPassword
optional

Password

string

DefRescanSecs
optional

Default rescan seconds

integer (int32)

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefRsm
optional

Default whether to resume failed transfers

string

DefSetFileAttr
optional

Default whether to file attributes

enum (0, 1)

DefSort
optional

Sort

enum (Date,A, Size,A, Filename,A, Date,D, Size,D, Filename,D)

DefUsername
optional

Username

string

DelOldStateDays
optional

Delete file stamp state entries after this many days (0=never)

integer (int32)

Desc
optional

Description

string

DirScriptID
optional

ID of directory parsing script

string

DotNET
optional

Ignored for SFTP

enum (0, 1)

EncAlg
optional

Encryption algorithm override: empty, or one of aes, aes-cbc, aes-ctr, 3des, blowfish

string

Group
optional

Groups the object belongs to

< string > array

Host
optional

Host

string

ID
optional

ID of the object

string

ID2
optional

ID of secondary host

string

IgnoreCertProbs
optional

Whether to accept any server key

enum (0, 1)

KexAlgs
optional

Prioritized list of acceptable key exchange algorithms

string

NATUseServerIPForData
optional

NAT user server IP for data

enum (0, 1)

Name
optional

Name of the object

string

OptimizeSSHBuf
optional

Whether to optimize performance with lookahead buffers

enum (0, 1)

Port
optional

Port

integer (int32)

ProxyHost
optional

Proxy host

string

ProxyPassword
optional

Proxy password

string

ProxyPort
optional

Proxy port

integer (int32)

ProxyType
optional

Proxy type: one of None, SOCKS4, SOCKS5, webstandard

string

ProxyUsername
optional

Proxy username

string

RenameAfterUpload
optional

Whether to rename after upload

enum (0, 1)

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

SSHFingerprint
optional

SSH finger print

string

ScriptPath
optional

Script path

string

Secure
optional

Whether to encrypt the connection

string

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

TempUploadName
optional

Temporary upload name

string

UTCOffset
optional

Offset from GMT, in seconds - used only by sync tasks

integer (int32)

UseDefStateCaching
optional

Use state caching

enum (0, 1)

UseNotif
optional

Not used for this host type

enum (0, 1)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.61. SSL Certificate

Name Description Schema

ExpDate
required

Expiration Date

string

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

IssuedTo
required

Issued To

string

Issuer
required

Issuer

string

Name
optional

Name of the object

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

SerialNum
required

Serial Number

string

Sha1Thumbprint
required

SHA1 Thumbprint

string

Store
required

Store

string

ValidFromDate
required

Valid From Date

string

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.62. SSL Certificate List Result

Name Description Schema

items
required

List of SSL Certificates

< SSL Certificate > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.63. Schedule

Name Description Schema

DateListRef
optional

Date list references

< Date List Reference > array

Days
optional

Days

Days

FailIfNoSuccessInSched
optional

Whether to fail when no successes have occurred by the end of the schedule

enum (0, 1)

Frequency
required

Frequency

Frequency

ID
optional

ID of the schedule

string

Multi
optional

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.

integer (int32)

OnlyUntilFirstSuccess
optional

Run the task during the scheduled time only until a task run was successful

enum (0, 1)

RunEvenIfNotif
optional

Schedule the task even if all sources are subject to notifications

enum (0, 1)

4.4.64. Schedules

Name Description Schema

Schedule
optional

List of schedules

< Schedule > array

4.4.65. Server Error Message

Name Description Schema

detail
required

An explanation specific to this occurrence of the error

string

errorCode
optional

The error code returned from the server

integer (int32)

status
required

The HTTP status code generated by the origin server for this occurrence of the error

integer (int32)

title
required

A short summary of the error type

string

4.4.66. Server Timezone Info

Name Description Schema

daylightBias
optional

Day light bias

string

timeZoneBias
optional

Time zone bias

string

timeZoneName
optional

Time zone name

string

4.4.67. Share Host

Name Description Schema

AdjDST
optional

Account for daylight savings

enum (0, 1)

DefMxBy
optional

Default maximum number of bytes per task run

integer (int64)

DefMxFi
optional

Default maximum number of files per task run

integer (int32)

DefPassword
optional

Password

string

DefRescanSecs
optional

Default rescan seconds

integer (int32)

DefRetryCount
optional

Default number of retries

integer (int32)

DefRetryTimeoutSecs
optional

Default retry timeout value in seconds

integer (int32)

DefUsername
optional

Username

string

DefWinCopyFileAPI
optional

Win copy file API

enum (0, 1)

DelOldStateDays
optional

Delete file stamp state entries after this many days (0=never)

integer (int32)

Desc
optional

Description

string

DriveLetter
optional

Drive letter

string

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

ID2
optional

ID of secondary host

string

Name
optional

Name of the object

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

StateCacheTime
optional

Length of time to cache state; -1=forever

integer (int32)

StateCacheUnit
optional

State cache unit

enum (Minutes, Hours)

UNC
optional

UNC

string

UseDefStateCaching
optional

Use state caching

enum (0, 1)

UseNotif
optional

Use filesystem notifications

enum (0, 1)

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.68. Sorting Field

Name Description Schema

sortDirection
required

Sorting order

enum (asc, desc)

sortField
required

Field name

string

4.4.69. Source Step

Name Description Schema

AB
optional

ASCII vs binary transfer mode; applies only to FTP

enum (ascii, binary)

Account
optional

The account to use during authentication; for FTP only. Rarely used.

string

AddCom
optional

Commands to execute (per file) before transfer; applies only to FTP

string

AddComAX
optional

Commands to execute (per file) after transfer; applies only to FTP

string

BlindDL
optional

Blind download enabled: if enabled, no directory listing is done prior to download

enum (0, 1)

Bucket
optional

S3 bucket name; for AWS S3 only

string

ClientCertSHA1
optional

Client certificate SHA1

string

ClientCertStore
optional

Client certificate store

string

ClientCertSubject
optional

Client certificate subject

string

ClientKeyID
optional

Client key ID

string

ConnTimeoutSecs
optional

Connection timeout seconds
Minimum value : 0
Maximum value : 32000

integer (int32)

Criteria
optional

Criteria that files must match

Criteria Type

DLInteg
optional

Whether to use download integrity checking. Must be one of "never", "ifsure", "ignore", or "always". Applies only to S3 hosts.

string

DataTimeoutSecs
optional

Data timeout in seconds
Minimum value : 0
Maximum value : 32000

integer (int32)

DelRename
optional

Whether to delete the "to" filename when renaming a downloaded file. +Applies only if DeleteOrig = 2.

enum (0, 1)

DeleteOrig
optional

What to do with a downloaded file after processing

enum (0, 1, 2)

DestFileAttr
optional

Destination file attribute

string

DownloadGroup
optional

Set this to "Collection" if downloading a "bundle" of web posts. This is a rarely-used feature that applies only to MOVEit Transfer hosts.

string

ExFile
optional

Mask of file names to be excluded from download

string

ExFo
optional

Mask of folder names to be excluded from download

string

FileMask
optional

Mask that files must match to be downloaded

string

FolderID
optional

MOVEit Transfer folder ID

string

FolderName
optional

Folder name

string

FolderType
optional

Folder type; rarely-used setting that applies only to MOVEit Transfer hosts

enum (-1, 1, 4, 10, 110, 19, 119, 99)

Format
optional

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
optional

ID of associated host

string

ID
optional

ID

string

MD5File
optional

Filename of the MD5SUM file; used only by FTP and SFTP

string

MD5Get
optional

Whether to process MD5SUM files

enum (IfPresent, Required, Never)

MDNFilenameToSend
optional

MDN filename to send

string

MDNPath
optional

Path of the Message Disposition Notification; used only by AS/x

string

MxBy
optional

Maximum number of bytes per task run
Minimum value : 0

integer (int64)

MxFi
optional

Maximum number of files per task run
Minimum value : 0
Maximum value : 99999

integer (int32)

NewFilesOnly
optional

New files only

enum (0, 1)

PartnerName
optional

Partner name

string

Passive
optional

Whether to use passive mode; used only by FTP

enum (0, 1)

Password
optional

Password

string

Path
optional

Folder path of the source or destination

string

RenameTo
optional

What to rename a downloaded file to after processing. Applies only if DeleteOrig = 2.

string

RescanSecs
optional

Rescan in seconds
Minimum value : 0
Maximum value : 999

integer (int32)

RetryCount
optional

Retry count
Minimum value : 0
Maximum value : 32000

integer (int32)

RetryIfNoFiles
optional

Whether to rescan for files if none were found

enum (0, 1)

RetryTimeoutSecs
optional

Retry timeout in seconds
Minimum value : 0
Maximum value : 32000

integer (int32)

ReuseSSL
optional

Whether to reuse SSL sessions; for FTP only

enum (0, 1)

Rsm
optional

Whether to attempt resume of transfers; 0 means no and 1 means yes

integer (int32)

SearchSubdirs
optional

Whether to search subdirectories

enum (0, 1)

SetFileAttr
optional

Whether to set file attributes after upload, if UseDefSetFileAttr is false

enum (0, 1)

Sort
optional

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, Size,A, Filename,A, Date,D, Size,D, Filename,D)

SubjectMatch
optional

Mask of email subject that must match for download. Applies only to AS/1 hosts.

string

SyDel
optional

Whether to synchronize deletions. Applies only to Sync tasks.

enum (0, 1, 2)

SyF
optional

Whether this is the "from" source. Applies only to Sync tasks.

enum (0, 1)

SyT
optional

Whether this is the "to" source. Applies only to Sync tasks.

enum (0, 1)

Type
optional

The host type of this step

enum (siLock, FTP, SSHFTP, FileSystem, SMTP, Share, POP3, S3, AS1, AS2, AS3)

UDMxBy
optional

Use the host’s default maximum bytes

enum (0, 1)

UDMxFi
optional

Use the host’s default maximum files

enum (0, 1)

Unzip
optional

Whether to unzip files whose name ends in .zip

enum (0, 1)

UseDefAB
optional

Use the host’s default ASCII vs binary; applies only to FTP

enum (0, 1)

UseDefBlindDL
optional

Use the host’s default blind download setting

enum (0, 1)

UseDefBucket
optional

Whether to use the host’s default bucket; for S3 only

enum (0, 1)

UseDefClientCert
optional

Use the host’s default client certificate

enum (0, 1)

UseDefClientKey
optional

Use the host’s default client key

enum (0, 1)

UseDefConnTimeoutSecs
optional

Use the host’s default connection timeout in seconds

enum (0, 1)

UseDefDLInteg
optional

Use the host’s default download integrity settings

enum (0, 1)

UseDefDataTimeoutSecs
optional

Use the host’s default data timeout in seconds

enum (0, 1)

UseDefMD5File
optional

Use the host’s default MD5 file

enum (0, 1)

UseDefMD5Get
optional

Use the host’s default setting for whether to process MD5SUM files

enum (0, 1)

UseDefPartner
optional

Use default partner

enum (0, 1)

UseDefPassive
optional

Use the host’s default passive

enum (0, 1)

UseDefRescanSecs
optional

Use the host’s default rescan seconds

enum (0, 1)

UseDefRetryCount
optional

Use the host’s default retry count

enum (0, 1)

UseDefRetryTimeoutSecs
optional

Use the host’s default retry timeout in seconds

enum (0, 1)

UseDefReuseSSL
optional

Use the host’s default reuse SSL; for FTP only

enum (0, 1)

UseDefRsm
optional

Use the host’s default resume of file transfers

enum (0, 1)

UseDefSetFileAttr
optional

Use the host’s default set file attribute

enum (0, 1)

UseDefSort
optional

Use the host’s default sort

enum (0, 1)

UseDefUser
optional

Use the host’s default user

enum (0, 1)

UseDefWinCopyFileAPI
optional

Use the host’s default Windows copy file API setting

enum (0, 1)

UseDefXS
optional

Use the host’s default setting whether to check integrity via XSHA1. For FTP only.

enum (0, 1)

UseLCaseComp
optional

Use lower case filename comparisons

enum (0, 1)

UseWinCopyFileAPI
optional

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
optional

Username

string

XS
optional

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.

string

4.4.70. Ssh Key

Name Description Schema

Fingerprint
required

Fingerprint

string

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

Name
optional

Name of the object

string

PublicKeyOpenSSH
required

Public key in OpenSSH format

string

PublicKeySSH
required

Public key in SSH format

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.71. Standard Script

Name Description Schema

Description
optional

Description

string

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

IsDest
optional

Is a destination script
Example : false

boolean

Name
optional

Name of the object

string

Params
optional

Script parameters

Parameters

ProcessDesc
optional

Process description

string

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.72. Standard Script List Result

Name Description Schema

items
required

List of standard scripts

< Standard Script > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.73. Start Task Response

Name Description Schema

nominalStart
optional

Nominal Start time of the task.

string

4.4.74. Steps Type

Name Description Schema

MicDestinationType
optional

Destination type

Destination Step

MicEmailType
optional

Email type

Email Step

MicForType
optional

For type

For Step

MicIfType
optional

If type

If Step

MicProcessType
optional

Process type

Process Step

MicRunTaskType
optional

Run task type

Run Task Step

MicSourceType
optional

Source type

Source Step

MicUpdOrigType
optional

Upd orig type

Update Original Step

4.4.75. Stop Task Input

Name Description Schema

nominalStart
optional

Nominal Start time of the task.

string

4.4.76. Task

Name Description Schema

AR
optional

1 means that the task should automatically be rerun if any source hits a maxfiles or maxbytes limit.

enum (0, 1)

Active
optional

0 means the task is never run by the scheduler or any of the notifiers.

enum (0, 1)

CAS
optional

"Compare Across Sources", an advanced sync-only option that is no longer supported.

enum (EMPTY, N, A)

CacheNames
optional

"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 (random, orig)

Group
optional

Groups the object belongs to

< string > array

ID
optional

ID of the object

string

Info
optional

Basic information of the task

Information

Name
optional

Name of the object

string

NextActions
optional

Next actions of the task

Next actions

NextEID
optional

Next entity ID. This is used by Admin to assign IDs to elements. Not needed by the server.

integer (int32)

Parameters
optional

Parameters of the task

Parameters

Renamed
optional

Whether the object has been renamed, readonly
Example : false

boolean

SameSecs
optional

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.

integer (int64)

Scheduled
optional

Readonly - Scheduled status of the task

enum (INCOMPLETE, UNSCHEDULED, DISABLED, ENABLED)

Schedules
optional

Schedules for running the task

Schedules

StateCacheTime
optional

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

integer (int32)

StateCacheUnit
optional

State cache unit: "hours" or "minutes". Default is minutes.

enum (Minutes, Hours)

TT
optional

Task type. "Sy" - Synchronization, "COS" - Advanced task, Empty (default) - Traditional.

enum (EMPTY, Sy, COS)

UseDefStateCaching
optional

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
optional

Steps included in the task. The type can be Destination, Email, For, If, Process, RunTask, Source and UpdOrig.

< Steps Type > array

xAddEditDelete
optional

Whether is permitted to add, edit and delete the object, readonly
Example : false

boolean

xAlter
optional

Whether is permitted to alter the task’s existing elements, readonly
Example : false

boolean

xRun
optional

Whether is permitted to run the task, readonly
Example : false

boolean

4.4.77. Task List Result

Name Description Schema

items
required

List of task objects

< Task > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.78. Task Log

Name Description Schema

exitStatus
optional

Status of task run

string

id
optional

Task Log Id

integer (int64)

logPath
optional

Path to location of log file

string

startTime
optional

Time the task run started

string

taskId
optional

Task Id

integer (int64)

4.4.79. Task Log List Result

Name Description Schema

items
required

List of task logs

< Task Log > array

paging
required

Paging information

Paging Information

sorting
optional

Sorting information

< Sorting Field > array

4.4.80. Task Runs Report

Name Description Schema

items
required

List of task runs report records

< Task Runs Report Record > array

sorting
optional

Sorting information

< Sorting Field > array

4.4.81. Task Runs Report Record

Name Description Schema

DurationSecond
optional

Duration in seconds

integer (int64)

EndTime
optional

End time

string (date-time)

FilesSent
optional

Number of files sent

integer (int32)

LogStamp
optional

Log timestamp

string (date-time)

Node
optional

Node ID

integer (int32)

NominalStart
optional

Nominal start time

string

QueryType
optional

Query type

string

RecType
optional

Record type

string

RunID
optional

Task run ID

integer (int64)

ScheduledTime
optional

Scheduled time

string (date-time)

StartTime
optional

Start time

string (date-time)

StartedBy
optional

Started by

string

Status
optional

Status

string

StatusCode
optional

Numeric error code (or 0 if no error)

integer (int32)

StatusMsg
optional

Error or status message

string

TaskID
optional

Task ID

integer (int32)

TaskName
optional

Task name

string

TotalBytesSent
optional

Total bytes sent

number (double)

4.4.82. Update Original Step

Name Description Schema

Action
required

The action to take: "d" to delete, "r" to rename, or empty to take no action

string

DelRename
optional

Whether we should delete the "rename to" file before renaming

enum (0, 1)

ID
optional

ID

string

RenameTo
optional

If action is rename, the new name (may include macros)

string

4.4.83. UserGroup

Type : object

4.4.84. Validation Error

Name Description Schema

field
optional

Name of the field having this validation error

string

message
required

The explanation of this occurrence of the error

string

rejected
optional

Value of the field having this validation error

string

4.4.85. Validation Error Message

Name Description Schema

detail
optional

An explanation specific to this occurrence of the error

string

errors
required

List of validation errors

< Validation Error > array

status
required

The HTTP status code generated by the origin server for this occurrence of the error

integer (int32)

title
optional

A short summary of the error type

string

4.4.86. ValueMapListResult«UserGroup»

Type : object

4.4.87. When Step

Name Description Schema

criteria
required

Criteria

Criteria Type

steps
optional

Steps included in this When step. The type can be Destination, Email, For, If, Process, RunTask, Source, UpdOrig and When

< object > array