Skip to main content

Manage your Moogsoft Cloud API keys

Many areas of the Moogsoft Cloud application, including integration configurations and the Moogsoft Cloud APIs, require that you have a Moogsoft Cloud API key. You can create and manage API keys under Settings > API Key Management.

API Key Management is for storing API keys created in Moogsoft Cloud only. However, you can store API keys from external systems to use with Moogsoft Cloud in the Credential Store. See Store external system credentials for more information.

About API keys

  • Users do not have API keys by default. You must create a key for yourself before you can use an API or integration requiring an API key.

  • You can retrieve and update information about an API key, but you cannot view the key itself. The key is visible only when the owner of the key first creates it.

  • Each API key is associated with the user who created that key. For information on how permissions and roles affect API key access, see Manage Moogsoft Cloud users and user roles.

  • You can create multiple keys for yourself. It is a good practice to use a separate API key for each data stream if you want to set up multiple integrations.

  • The operations available to you depend on your role and permissions. See Manage Moogsoft Cloud users and user roles for more information.

Create an API key

Add a new API key to use with Moogsoft Cloud features.

  1. Navigate to Settings > API Key Management.

  2. Click Create API Key + at the top right of the page.

  3. Enter a name and description for the key, and then click Create.

NOTE: Copy and save the key in a secure text file immediately after you create the key. You cannot view the key again.

Revoke an API key

Revoke an API key if it is no longer needed, or for security reasons. The key will no longer work after it is revoked.

  1. Navigate to Settings > API Key Management.

  2. Select the keys to revoke.

  3. Click Revoke.

    In about five minutes the key will be revoked.

Rotate API keys for deleted users

When a user is deleted, any API keys created by that user stay in the system. Retaining the old key in this way makes it possible for your organization to create a new key for a valid user as a replacement without losing access to key integrations or scripts.

Removing the old key and replacing it with a new key is highly recommended, as an API key is a credential for accessing Moogsoft Cloud. Anyone with Edit permission for Credentials can perform the following key rotation procedure:

  1. Create a new key in Moogsoft Cloud.

  2. Apply the new key to the third-party tool or script, replacing the key associated with the deleted user.

  3. Delete the old key.