Connections, auth and API

My API access key is about to expire. How do I renew it?

Create a new access key, switch every integration and API client to it, then turn off or delete the old key.

How-to

Short answer: You can't extend a key. Create a new access key, move every integration and API client to it, then retire the old one.

Why it happens

  • Every access key has an expiry period set when it's created. Calls and connections that use the key fail once it expires, is turned off or is deleted.
  • Admins can cap how long new keys stay valid.

How to fix it

  1. Click your profile picture > My settings > API authentication > Access keys.
  2. Click Create access key, enter a name and set an expiry period.
  3. Copy the access key ID and secret, or click Download credentials.
  4. Update every API client to send the new values in the X-Access-Key-Id and X-Access-Key-Secret headers.
  5. For integrations, re-authenticate each connection that used the old key.
  6. Delete the old key once nothing uses it.

For service account keys, create and manage them from the service account. See creating and managing access keys.

If you call a third-party API with a bearer token through the HTTP connector, put the token in one place only. Either set the connection to No authentication and add an Authorization header, or store the token in the connection. Using both can make calls fail.

Important

Each user can have up to 20 access keys. Deleting a key revokes every connection created with it, so switch connections first. Admins set the maximum expiry under Access key setting.

Related answers