Create an API key for a user

To use the Deep Security Manager API, you will need an API key.

API keys can only be used with the newUse the Deep Security API to automate tasks available in Deep Security Manager 11.1 and later.

Trend Micro recommends creating one API key for every user needing API access to the Deep Security Manager.

You can automate API key creation using the Deep Security API. For examples, see the Create and Manage API Keys guide in the Deep Security Automation Center.

To create a new API key:

  1. Go to Administration > User Management > API Keys.
  2. Click New.
  3. In the Properties window, enter a Name and Description for the API key.
  4. Click on the Role list and select a role. Auditor grants read-only access to the Deep Security Manager through the API, while Full Access grants both read and write access. If you need more specific roles for API key users, you can select New and define one. See Define roles for users for more information on doing so.
  5. Select a Language.
  6. Select a Time Zone.
  7. Optionally select Expires on and select an expiry date for the API key.
  8. Click OK.
  9. Copy the Secret key value.

    Make sure to copy the secret key value now, this is the only time it will be shown.

Lock out an existing API key

If an existing API key has been compromised you can lock it out:

  1. Double click on the API key you want to lock out.
  2. Optionally select Locked Out (Denied permission to authenticate) to block usage of the API key.
  3. Click OK.