Skip to main content

Authorization

Follow this guide to create a new Opsgenie credential that will allow Nexla to authenticate to and exchange data with your Opsgenie account.
opsgenie_api_auth.png

Opsgenie

Prerequisites​

Before creating an Opsgenie credential, you need to obtain your API key and identify your API instance URL from your Opsgenie account. Opsgenie uses API key authentication for all API requests, with the API key sent in the Authorization header with the GenieKey prefix.

To obtain your Opsgenie API credentials, follow these steps:

  1. Sign in to your Opsgenie account using your administrator credentials.

  2. Navigate to Settings > Integrations or Settings > API in the Opsgenie interface.

  3. Look for the API Keys or API Integration section in your account settings.

  4. If you don't have an API key yet, click Add API Integration or Create API Key to create a new API key.

  5. Configure your API key settings:

    • Enter a name or description for the API key (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the key

  6. Click Save or Create to create the API key.

  7. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  8. Identify your API instance URL based on your Opsgenie instance:

    • US Instance: https://api.opsgenie.com
    • EU Instance: https://api.eu.opsgenie.com

  9. Store both the API key and API instance URL securely, as you will need them to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization header with the GenieKey prefix (e.g., Authorization: GenieKey {api_key}) for all API requests to the Opsgenie API. The API instance URL determines which Opsgenie instance (US or EU) your API requests will be sent to. The API key authenticates your requests and grants access to Opsgenie resources based on your account permissions and the key's scopes. If your API key is compromised, you should immediately revoke it in your Opsgenie account settings and generate a new one. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the Opsgenie API documentation.

Create an Opsgenie Credential​

  • To create a new Opsgenie credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Opsgenie

OpsgenieCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

Opsgenie uses API key authentication for all API requests. The API key is sent in the Authorization header with the GenieKey prefix to authenticate API requests to the Opsgenie API.

  1. Enter your Opsgenie API instance URL in the API URL field. Select https://api.opsgenie.com for US instances, or https://api.eu.opsgenie.com for EU instances. The API instance URL determines which Opsgenie instance your API requests will be sent to.

  2. Enter your Opsgenie API key in the API Key field. This is the API key you obtained from your Opsgenie account settings (Settings > Integrations > API Keys). The API key is sent in the Authorization: GenieKey {api_key} header for all API requests to the Opsgenie API. The API key is sensitive information and must be kept confidential.

    Your Opsgenie API key can be found in your Opsgenie account settings under Settings > Integrations > API Keys. The API key is sent in the Authorization: GenieKey {api_key} header for all API requests to the Opsgenie API. The API instance URL should match your Opsgenie instance (US or EU).

    If your API key is compromised, you should immediately revoke it in your Opsgenie account settings and generate a new one. The API key provides access to your Opsgenie account data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about obtaining API keys, API authentication, and available endpoints, see the Opsgenie API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.