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 the Helix Control-M Automation API online documentation.


  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, enter a name for token.

    2. In the Roles field, remove or re-select 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 and select the relevant roles.

      If you have Advanced Admin Authorizations, you can generate a token on any role.

    3. In the Expiration date field, set a date for token expiration.

      If you leave this field empty, the token is operative indefinitely and does not expire.

  5. Click Generate.

    The New API Token message displays 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 the same token (with a new token value).

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