Skip to main content

REST APIs for 24.2.20 and 24.2.10

Create API Keys in the Web Console

You can create API keys using the Web console with the User Menu:

  1. In the drop-down User menu, select My API Keys.

    A list of configured API keys is displayed.

    If no API keys are configured, the message "No API Keys" is displayed.

  2. To add a new API key, click Add.

  3. In the Create API Key pop-up window, enter a name for the API key in the Name field. Optionally, enter a description in the Description field.

  4. Click Save to save your API key or click Cancel to close the pop-up window without saving your changes.

  5. When the API Key Created window appears, click the > button next to "Show credentials" to display the credentials for your API key.

    The following information is displayed:

    • Key ID: The unique ID of the API key

    • Authentication Username: The username that authenticates the API calls

    • Secret: The password for the API key

  6. Click Download Credentials to download the credentials as a text file. Make sure that you have saved the credential information before clicking Done.

After you click Done, the API Keys page displays a summary of your new API key, including the following information:

  • Name

  • Description

  • Key ID

  • Authentication Username

  • Created On

Note

The credential information is displayed only once. Make sure to save it in a secure location because it is used to access the API for your organization. You must create a new API key if the credential information is lost.