Signals Notebook: Generating an API Key for the Correct Endpoint URL in Your Tenant

This article is for administrators only.

Problem

When multiple URLs are assigned to a single Signals Notebook tenant, it will have multiple base URLs for the API endpoints. For example:

If the tenant has the following URLs:

• Tenant URL #1: https://mysnb.signalsresearch.revvitycloud.com
• Tenant URL #2: https://mysnb-2nd.signalsresearch.revvitycloud.com

The tenant will have the following base URLs for API endpoints:

• Base URL #1: https://mysnb.signalsresearch.revvitycloud.com/api/rest/v1.0
• Base URL #2: https://mysnb-2nd.signalsresearch.revvitycloud.com/api/rest/v1.0

You can use both base URLs in your API calls, but you must use the correct API key for each.

Solution

API keys are tied to the tenant URL used when they were created. Even for the same tenant, you cannot use a single API key across different tenant URLs.

For example, in the previous use case, if you use Base URL #2 in your script, you must generate an API key after logging into Tenant URL #2. Follow the general instructions below.

1. Identify the URL you want to use for the base URL in your API calls.
2. As an administrator, log in to the tenant using the URL you selected above.
3. Review the following instructions to generate an API key for the selected user:
   Generate an API key from the Signals Configuration