Skip to main content

API Key

This page allows you to retrieve or generate an API key for a specific site. The API key is a unique identifier used to authenticate requests to the API. It is crucial for securing the communication between your application and our services.

View Sites Page and click the Admin dropdown menu (represented by a gear icon) for a site, then select API Key to access this page.

Form Information​

The form on this page does not require any input. You simply click a button to trigger the API key generation process.

Important Notes​

  • API Key Replacement: Generating a new key will invalidate the old key. Any application or service using the old key will stop working. You must update all your applications with the new API key.
  • Permissions: Only users with Admin access to a site can generate a new API key.

Troubleshooting​

  • Error Message: "You don't have admin access to this site id": This means your user account does not have the necessary permissions to perform this action. Contact your account administrator.
  • Error Message: "Unable to generate API Key, please try again later": This indicates a temporary issue with the system. Please wait a few minutes and try again. If the issue persists, contact support.