Skip to content
This repository was archived by the owner on Oct 8, 2024. It is now read-only.

Manage API Keys

Jump to bottom
John (he/him) edited this page Jul 24, 2024 · 4 revisions

Managing API Keys on Augmend.com

API keys on Augmend.com allow developers to authenticate and interact with Augmend's APIs securely. Each API key is unique and provides access based on the permissions assigned to it.

Perquisite

Create an Augmend account here.

Viewing API Keys

Navigate to the API Keys section in your account settings (https://augmend.com/settings). The API Keys Table will display entries for all your existing non-expired API keys along with their descriptions. Note that the actual keys are not visible, only the creation date, expiration date and description.

image

Not finding a key?

Expired keys are removed automatically.

Creating an API Key

  1. Click the "Create" button to open the Create API Key Modal.

  2. Provide a description for the new API key (or use the default created). image

  3. Submit the form to generate a new API key.

  4. The new API key will be displayed in the Show API Key Modal. Make sure to copy and save your API key in a secure location as it will not be shown again. image

    ⚠️ Important: Your API Key will only be visible this one time, copy it to your clipboard and use it the application requesting permissions (e.g. Zapier, or Video Upload API). Once the modal is closed you will not be able to view the key again.

Deleting API Keys

  1. From the API Keys Table, select the API keys you wish to delete.

  2. Click the "Delete Selected" button to remove the selected API keys.

    image

  3. A confirmation dialog will appear. Confirm the deletion to proceed.

    image

Security Considerations

  • Treat your API keys as sensitive information. Do not share them publicly or with unauthorized individuals.
  • Regularly review and prune unnecessary or unused API keys to minimize security risks.

Augmend.com

Clone this wiki locally