Creating an API Token

This procedure describes how to create an API token in the Configuration domain of Control-M. API tokens are used for user authentication when running API commands.

For more information about the API, see Helix Control-M Automation API.


  1. From the icon, select Configuration.

  2. From the drop-down list, select API Tokens.

    The API Tokens tab appears.

  3. Click Add Token.

    The Add API Token pane appears.

  4. Do the following:

    1. In the Token Name field, type a token name.

    2. In the Roles field, remove or select the rolesClosed An authorization entity that grants permissions to associated users to access different functionality. that you want to associate with the API token.

      By default, all roles are selected.

      To remove associated roles, click the drop-down arrow in the top right corner of the Roles field, and then clear the checkboxes next to the relevant roles.

      If you have the appropriate authorization access level for Secrets (Update or Full), you can generate a token on any role.

    3. From the Expiration Date drop-down list, select one of the following dates:

      • Indefinitely

      • Expires in One Year

      • Specific Date

  5. Click Generate.

    New API Token dialog box appears with the token value and enables you to copy it to your clipboard.

  6. Click Done.

    If you cannot find the token value, use the Regenerate Token button to generate a new token value.

    If a user is moved to different role or is no longer within the organization, you must delete their token and generate a new one.