This article is not applicable to the selected version.
API access keys provide a secure means to programmatically access certain Server functions from another application. API access currently allows read-only access to Server reports. Refer to Using Reports for more information on the available reports.
An API access key can only be created by system or project administrators and is valid until the key is deleted. If the user is removed from the applicable role, the API access key is also removed. If the user who created the API access key is deactivated, the key remains but cannot be used until the user is activated again.
- Click on the username and dropdown on the top banner of the Management Center.
- Click My API Keys.
- Review the following information:
Displays the name of the API access key.
Displays the date and time the API access key was created.
Displays the API for which the API access key was created.
- Choose from the following options:
If You Want To
Create a new API Access key
- Click New Key.
- Enter the Key Name.
- Select the APIs for which the key is being created.
- Click Generate Key to display the key.
- Review the newly created Key.
NOTE: This is the only time you will be able to view the key.
NOTE: The key will also be copied once you close the window.
to copy the key to a secure place.
- Click Close.
Remove an API key
Click X beside the key you want to remove.