Quest Spotlight Enterprise Integration Guide

This integration requires use of our v1 REST API which was decommissioned on October 19, 2018.

For more information about the v1 REST API decommissioning, take a look at our FAQ here:

Please contact Quest support to inquire about the status of this upgrade.

Quest Spotlight Enterprise delivers simplicity without compromise by providing unmatched monitoring, diagnosis and optimization of your SQL Server environments, ensuring peak performance around the clock.  With intuitive overviews of enterprise health and performance, automated alerts and actions, an integrated Xpert tuning module and mobile device support, Spotlight on SQL Server Enterprise makes it easier than ever to obtain the data you need to ensure the health of your SQL Server databases.

Please note, you will need to have the admin role on the account to add/view the API Access keys.

In PagerDuty

  1. Go to the Configuration menu and select API Access.
  2. On the API Access page, click Create New API Key.
  3. In the dialog that pops up, you’ll be prompted to enter a Description for your key, and choose an API version. Select v1 Legacy for this integration. You will also have the option to create the key as Read-only; leaving this box unchecked will create a full access key.

    Note: This integration uses API v1, and will not work with an API v2 key.

  4. Once you have filled in your description, click Create Key.
  5. Once you click Create Key, you will see a dialog displaying your key and confirming the options you filled in on the previous step. Make sure to copy this key into any application that needs it now, as you will not have access to the key after this step. If you lose a key that you created previously and need access to it again, you should remove the key and create a new one. Click Close once you have successfully copied your key.
  6. Once created, you will see your key appear in the list of keys on the API Access page, with versioning noted.
  7. Go to the Configuration menu and select Services.
  8. On the Services page:
    • If you are creating a new service for your integration, click Add New Service.
    • If you are adding your integration to an existing service, click the name of the service you want to add the integration to. Then click the Integrations tab and click the New Integration button.

  9. Select your app from the Integration Type menu and enter an Integration Name.If you are creating a new service for your integration, in General Settings, enter a Name for your new service. Then, in Incident Settings, specify the Escalation Policy, Notification Urgency, and Incident Behavior for your new service.
  10. Click the Add Service or Add Integration button to save your new integration. You will be redirected to the Integrations page for your service.
  11. Copy the Integration Key for your new integration.

On Your Spotlight Server

  1. Go to ConfigureDiagnostic Server.
  2. Click Configure PagerDuty.
  3. Fill in the API Access Key and Service API Key fields with the API Access and Integration Keys you created earlier, then click Trigger Test Incident.If everything is correct, you should see a new incident triggered in your PagerDuty account. Click OK to continue to the next steps.

  4. Go to ConfigureAlarm Actions.
  5. Click New….
  6. Give the action a Name and select the Conditions that you would like to trigger a PagerDuty incident for. Check Send PagerDuty Incident and then click OK.
  7. Congratulations! You’ve completed the integration with Spotlight. Now when an alarm triggers, is acknowledged or resolved within Spotlight, it will trigger a new incident (or update the corresponding incident) within PagerDuty.


How do I configure Spotlight to work with multiple PagerDuty services?

Unfortunately this isn’t possible. Spotlight integrates with a single PagerDuty service.

Will actions in Spotlight reflect in PagerDuty?

Yes. Acknowledgements and resolves in Spotlight will reflect in PagerDuty, however actions from PagerDuty will not reflect in Spotlight.