Follow

Guide to: Regenerating API Keys

Overview

Appen allows requestors to regenerate their API key at any time via the Account page. This guide walks through how to regenerate API keys and some considerations to keep in mind when regenerating keys.

How to Regenerate API Keys

1. Navigate to your Account page and select the “API” tab

blobid0.png

2. Select the “Generate New” button 

blobid1.png

3. This will trigger a newly generated API key to be used in API integrations with your account.

Impact of Regeneration and Considerations

  • API Integrations 

    • Many customers create custom scripts to automate their data pipelines. 
    • After regenerating an API key, be sure to update all scripts with the new key to ensure commands run successfully. 
  • Webhooks 

    • job owner’s API key is related to the webhook signature provided by our platform.  
    • If the job owner’s API key is regenerated and webhook signature verification is in place, please update the signature verification process with the regenerated API key of the job owner.  

Note: API keys from team members can be used to post data to a job, however, only the job owner’s API key can be used to verify webhook signatures. 

  • Cross Team Access 

    • Cross Team Access is an organization-level feature that allows a user to utilize their API key across multiple teams.  
    • To verify if the setting is enabled in your organizationplease see the GIF below on how to toggle between teams: 

66d1399e-4e28-4e68-bb82-b1f676ff944b.gif

Figure 1: Users with Cross Team Access enabled will have options to toggle between teams via the letter icon under Global Navigation. 

  • Users with Cross Team Access enabled should take note of their API Team ID. After regenerating API keys, be sure to ensure the Team ID associated with API commands are executed within the correct team. Instructions for setting an API team can be found under "API Updates" of our Cross Team Access article. 

Note: if an API Team is not set the platform will default to the current team selected in the UI.


Was this article helpful?
0 out of 0 found this helpful


Have more questions? Submit a request
Powered by Zendesk