The following tutorials introduce you to common best practices of using Control-M Automation API.

Before You Begin

To successfully step through the tutorials in this section, perform the following preparatory steps before you begin the tutorials:

  • Ensure that you have successfully completed API setup, as described in Setting Up the API.

  • Ensure that you have Git installed. If not, obtain it from the Git Downloads page.

  • Fetch tutorial samples from GitHub and create a local copy of the source code using the git clone command:

    git clone https://github.com/controlm/automation-api-quickstart.git
  • To access Control-M Automation API documentation, you can use the following API commands:

    • Return REST API documentation:

      ctm documentation restApi
    • Launch web-based documentation:

      ctm doc gettingStarted

List of tutorials

The following tutorials are available to get you started working with Control-M Automation API:



Defining Authorizations for Control-M Roles and Users

Explains how to define new roles and users for Control-M and how to control the authorizations that they have for Control-M resources.

Creating Your First Job Flow

Explains how to write jobs that execute OS commands and scripts.

Automating Code Deployment

Explains how DevOps engineers can automate code deployment.

Running Applications and Programs in Your Environment

Explains how to run the following types of job flows:

Building a Docker Container for Batch Applications

Explains how to build a docker container for Control-M/Agent and run some basic API commands.

Sending Events to External Monitoring Tools

Explains how to set up the transfer of alerts to an external client for monitoring through external tools, such as an event management system.

Additional code samples

Additional code samples are available through the Control-M GitHub pages: