Topics on this page
Create an API Key using the Workload Security console
Create an API key to use for authenticating your requests with Workload Security. Trend Micro recommends creating one API key for every user needing API access to the Workload Security.
Upon creation of an API key, you are provided a unique secret key that is associated with the API key. You use this secret key with your API calls for authenticating. You must store the secret key when it is provided because at no other time are you able to obtain it. If you lose the secret key you must create a new API key or create a new secret key for the API key.
An account with administrator privileges is required to create an API key.
To create a new API key:
- Go to Administration > User Management > API Keys.
- Click New.
- In the Properties window, enter a Name and Description for the API key.
- Use the Role list to select a role. Auditor grants read-only access to the Workload Security 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.
- Select a Language.
- Select a Time Zone to associate with the key. This is the default time zone used for interpreting date and time values in API calls and responses.
- Optionally, select Expires on and select a date to limit access to a specific period of time.
- Click OK.
- Copy the Secret key value.
Make sure to copy the secret key value now. This is the only time it is shown.
Lock out an existing API key
If an existing API key has been compromised, you can lock it out as follows:
- Double click on the API key you want to lock out.
- Optionally, select Locked Out (Denied permission to authenticate) to block usage of the API key.
- Click OK.