API Connections Not Working

Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.

Article Goal

In this article we cover troubleshooting why you may not be able to connect to your API connection profile inside VDM.

Problem

Can't connect to database inside VDM via API

Solution

1. Open your appsettings.json file for WebReports.

2. Change the "AllowAPIKeysForVDM" from "false" to "true"

Note: If your appsettings file does not have the "APISettings" section, you will need to add it. Please keep in mind if you add the "APISettings" section into your appsettings at the end of the file you will not want to include the comma at the end (the comma separates additional properties inside the appsettings and would result in an invalid file format). 

Appsettings.json configuration for disabling user-centric API keys with VDM (Default Setting)

"APISettings": {"AllowAPIKeysForVDM": false},

Appsettings.json configuration for enabling user-centric API keys with VDM

"APISettings": {"AllowAPIKeysForVDM": true},