Control-M Automation API

Control-M Automation API is a set of programmatic interfaces that provide developers and DevOps engineers access to the capabilities of Control-M within the modern application release process. Job workflows and related configuration objects are built in JSON and managed with other application artifacts in any source code management solution, such as Git. This approach enables capabilities such as sophisticated scheduling, flow control, and SLA management to be built-in from inception and used during the execution of batch applications as they are automatically deployed in development, test, and production environments.

Control-M Automation API provides an automated interface to Control-M. You can manage job workflows as code, similar to the way modern configuration management solutions manage infrastructure as code. The actual execution of batch jobs is managed by Control‑M. For more information about Control-M, see Introduction to Control-M.

You can use a Command Line Interface (CLI) or the REST API to build, run, and test jobs against an existing Control-M instance. A local workbench provides initial job flow unit testing functions, which are a subset of the complete set of Control-M capabilities. You can check your workflows, once they are ready, into your source control system with the remainder of your project files. The Automation API provides services to package and deploy job workflows to the Control-M environment. Control-M schedules and operates on the most recently deployed workflows.

Additionally, Control-M Automation API provides services to provision Control-M/Agent machines and configure host groups.

No prior experience with Control-M is required to write jobs. You can work through this guide and its Tutorials to get started. The guide introduces you to the concepts of Control-M Automation API and provides examples of workflows. You can get more information about creating jobs by following the steps in the Creating Your First Job Flow tutorial, and learn more about accessing Control-M Automation API services to build, test, and deploy your jobs in Automation API Installation.

Control-M Automation API decentralizes access to Control-M entities and provides them directly to developers. You can use Control-M Automation API to access Control-M via a REST API HTTP endpoint.

API Installation

Monthly releases of Control-M Automation API are available for download from Amazon S3 storage or from the Electronic Product Distribution (EPD) site. Different versions of the API can live side-by-side. A newer API is not overwritten when you install a version of Control-M that contains an older version of the API.

Control-M Automation API monthly releases are compatible with a variety of Control-M 9.x versions, starting with Control-M 9.0.19 and including all higher versions. Specific features that require a higher version of Control-M are indicated in the current documentation, and the minimum version of Control-M that is compatible with each feature is specified.

To install Control-M Automation API, you can choose between the following options:

  • Install Control-M Workbench, which includes the Control-M REST API.

    Control-M Workbench provides a development environment that enables you to build, run, and test your job workflows. You can make changes and validate your changes in Workbench without effecting the work of other stakeholders.

  • Perform a standard installation of Control-M. The Control-M REST API is available from Control-M/Enterprise Manager.

In addition to the ability to send REST API requests, you can also run Control-M Automation API commands via a CLI. The Control-M Automation CLI is available for installation as a Node.js package.

For more information, see Automation API Installation.


BMC provides you with a group of tutorials that introduce you to common best practices for Control-M Automation API. See Tutorials.