API Keys

Updating an API Key

To update an API Key:

1. Click API on the main menu.
2. Select API Keys.
3. Find the API Key that you want to update on the 'API Keys' tab and click on its Edit row action link.
4. Make your changes and click on the UPDATE button.

Note: Special character(s) are converted to HTML character entities. You can use the liquid filter html_safe to handle this.

Viewing API Key Update Histories

To view API Key update histories:

1. Click API on the main menu.
2. Select API Keys.
3. Select the 'History' tab where the API Key updates are displayed in a list.
4. View an API Key update history in detail by clicking on the details icon to the right of their row. The detail view displays information in three columns:
   • Edited Field(s)
   • Value Before
   • Value After

Deleting API Keys

To delete an API Key:

1. Click API on the main menu.
2. Select API Keys.
3. Find the API Key that you want to delete on the 'API Keys' tab and click on its Delete row action link.
4. Select DELETE on the confirmation modal.

Note: Deleting an API key affects all pages and/or system configurations that were previously using it.