Create an API key for automatic updates

To keep download reports current, you can create an application programming interface (API) key that enables synchronization of your Puppet estate with Puppet Forge. You can enable synchronization for your organization or for your personal Puppet Forge account. Because synchronization is a sensitive operation, multifactor authentication is required as part of the setup procedure.

If you enable synchronization for your organization, the API key is valid for the organization, and individual members will not see the key in their individual Forge profiles.

Before you begin

Ensure that you can access the email address associated with your Puppet Forge account. A secure code is sent to this address during multifactor authentication.

Procedure

To enable real-time updates in Forge:

  1. Log in to Puppet Forge by selecting Log in at the upper right and following the prompts.

  2. At the upper right, select the down arrow next to your username to display a menu and take one of the following actions:

    • To synchronize download reporting for an organization, select the organization.

    • To synchronize download reporting for your personal account, select your personal account.

  3. In the navigation pane, select API keys.

  4. Select Create a new key.

    The Create an API key dialog opens.

  5. Optionally, in the API Key Description field, add a description. For example, you can write API key for the production environment.

  6. To specify the length of time that the key will be valid, in the Key Validity field, select a value representing the number of days. The maximum time is one year.

  7. Select Create API key.

  8. If the Multifactor authentication dialog is displayed, in the Authentication Code field, enter the secure code sent to the email address associated with your Puppet Forge account.

  9. Select Submit.

    The New API Key dialog displays the API key.

  10. Copy the API key for future reference.

Results

The API Keys window displays information about the newly created key.

What to do next

Configure the API key as described in Puppet Forge: Customize your user experience and track module downloads.