Skip to main content
Gainsight Inc.

Generate API Access Key

Overview

Gainsight API access key is a unique access key used for authentication of Gainsight REST API requests. Gainsight Admins generate this access key in the Connectors 2.0 page and is consumed by developers to pass this in the request header “Accesskey” for all the API requests into Gainsight. To generate an access key, navigate to Administration > Connectors 2.0 > Connectors tab > Gainsight API Widget. 

Admins can create only one Access Key per tenant and it does not expire. Gainsight authenticates REST API requests by verifying this access key and if the authentication succeeds, access to Gainsight platform is granted to developers. You can reset the existing access key anytime, but the new access key should be replaced in headers of all the future API requests.

Generate Access Key

To generate an access key: 

  1. Navigate to Administration > Connectors 2.0 > Connectors tab > [Click Gainsight API].

  2. Click the Create Connection button and click GENERATE ACCESS KEY.

Establish connection to Gainsight widget.gif

  1. A new Access Key is generated that you can copy and use as an authentication for all of the REST API requests into Gainsight.

Generating access key.png

  1. Click RESET ACCESS KEY to reset the existing access key anytime later.

Note: New access key should be replaced in headers of all the future API requests.

 

  • Was this article helpful?