Overview

MOVEit Automation API allows you to connect to MOVEit Automation, start tasks, and obtain information on the status of currently running and completed tasks.  It provides a subset of the capabilities of the human-oriented GUI MOVEit Automation Admin program, but also provides the ability to perform operations that cannot be accomplished through the GUI program alone, such as picking different sources (even ad-hoc hosts) at runtime and limiting the submission of tasks if the number of tasks already running is more than desired.

MOVEit Automation API flow

In ordinary use, MOVEit Automation starts tasks itself automatically, based on schedules that you configure, and/or based on notifications of the arrival of files.  However, in some cases, you may want to control tasks or create/run temporary tasks from another application.  For instance, you may have an existing scheduling application that is used for a number of different purposes and you want to integrate MOVEit Automation's secure transport and processing capabilities into it.   MOVEit Automation API allows you to use such an application to control MOVEit Automation tasks.

When accessed with administrative credentials, reports about past task runs, file/folder activity and audit logs may be generated through MOVEit Automation API. Information about currently running tasks is also available to those applications providing administrative credentials.

This document describes the Microsoft Windows version of MOVEit Automation API.  This consists of a command-line client and a programmatic interface.  Both provide similar capabilities (though the programmatic interface provides more); choose which one to use according to your needs. The programmatic interface supports both 32-bit and 64-bit applications.

There is also a very similar Java version of the API.  All versions require that the MOVEit Automation server being connected to be licensed for the MOVEit Automation API option.