Manage API keys

Who can use this: Tech admin

Available on: Any Gong plan

API keys give external systems access to your company's Gong data through the public API. Each key can be restricted to specific IP addresses; when Trusted IPs are set, the key can only be accessed from those addresses. You can create new keys, update existing ones, and delete keys that are no longer needed.

Create an API key

Each key can be restricted to specific IP addresses and given an expiration date. Both fields are optional. Leave either or both empty if you don't need those controls.

To create an API key:

1. From the left sidebar, click Admin center.

2. In the Settings tab, click API under Ecosystem.

3. Click + Get API key.

4. Enter a name for the key in the Key name field.

5. Enter the number of days until the key expires in the TTL (days) field. Leave this field empty if the key should not expire.

6. Enter the IP addresses, CIDR blocks, or IP ranges to allow in the Trusted IPs field. Separate entries with line breaks or spaces. IPv4 and IPv6 are supported.

   Note:

   If you leave this field empty, the key can be used from any network location.

7. Click Get API key. The access key and secret are displayed.

8. Copy the access key and secret to be used later. The secret can't be retrieved once you close the dialog box.

9. Click Done.

The API key is generated and added to the list of keys displayed in the API keys tab.

Edit an API key

Update a key's name, expiration date, or trusted IP addresses at any time. Changes to Trusted IPs can take up to five minutes to take effect; all other changes are immediate.

To edit an API key:

1. From the left sidebar, click Admin center.

2. In the Settings tab, click API under Ecosystem.

3. Click the More actions icon on the row of the API key you want to edit and click Edit.

4. Update the fields as needed.

5. Click Save changes.

The key is updated in the API keys table.

Delete an API key

Deleting a key immediately revokes access for any system that uses it. This action cannot be undone.

To delete an API key:

1. From the left sidebar, click Admin center.

2. In the Settings tab, click API under Ecosystem.

3. Click the More actions icon on the row of the API key you want to delete and click Edit.

4. Click Delete.

5. Check I understand and click Delete API.

The key is removed from the table and access to the Gong API with this key is revoked.

Frequently asked questions