Keys
  • 28 Feb 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Keys

  • Dark
    Light
  • PDF

Article Summary

On the Keys page, you can:

  1. Find an API key.
  2. Create an API key.
  3. Perform additional actions on an API key.

Keys%20page

Find API key

To find an API key, in the Search field of the Keys page, enter the needed API key name, and in the list that appears, select the API key you are looking for.

Find%20API%20key

Create API key

To create an API key:

  1. In the upper-right corner of the Keys page, click Create API Key.
    Create%20API%20key%20button

  2. In the New API Key dialog:

    1. (Optional) Click Choose file and upload a file.
    2. Enter the API key name in the Name field.
    3. Enter the webhook URL in the Webhook URL field.
    4. Select the needed account checkbox.
    5. Click Create.

    New%20API%20key%20dialog

The new API key is created and the success message appears at the top of the page.

Api%20key%20created

Perform additional actions on API key

On the Keys page, you can perform additional actions on an API key:

Modify API key

To modify an API key:

  1. Hover over the needed API key and click the edit icon Edit%20icon1.
    Modify%20API%20key

  2. In the Modify API Key dialog, edit the current API key data and click Modify.
    Modify%20API%20key%20dialog

The API key is modified, and you can see it in the API key list.

Copy API key token

To copy an API key token, hover over the needed API key and click the copy icon Copy%20icon4. The API key token is copied, and the success message appears at the top of the Keys page.

API%20key%20token%20copied

Block or unblock API key

To block an API key:

  1. Hover over the needed API key, click the options icon Options%20icon4, and then select Block.
    Block%20API%20key

  2. In the Block API Key confirmation dialog, click Block.
    Block%20API%20key%20dialog

The API key is blocked and marked with a red dot next to its avatar, and the success message appears at the top of the Keys page.

API%20key%20blocked

To unblock an API key, hover over the needed blocked API key, click the options icon Options%20icon4 and in the dropdown list, select Unblock.

Unblock%20API%20key

The API key is unblocked, its avatar no longer has a red dot, and the success message appears at the top of the Keys page.

API%20key%20unblocked

Delete API key

To delete an API key:

  1. Hover over the needed API key, click the options icon Options%20icon4 and in the dropdown list, select Delete.
    Delete%20API%20key

  2. In the confirmation Delete API Key dialog, click Delete.
    Delete%20API%20key%20dialog

The API key is deleted and doesn’t appear in the API key list.


Was this article helpful?

What's Next