Create a WebReports API Key – BridgeWorks Help Center

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

Learn how to create an API Key in WebReports for secure, user-specific access to the WebReports API. This is essential for enabling integrations, automation, and VDM API-based connection profiles.

Why Create a WebReports API Key?

API Keys are a secure, flexible method of authenticating application requests to the WebReports API. Instead of username/password credentials, API Keys can be assigned to users and scoped to specific hosts or IPs for added control.

Secure access to WebReports from third-party apps or scripts
Enabling VDM connection profiles to connect via API Key
Allowing automation or integration tools to run reports

Important: You will only see the API Key once when it's created. Be sure to securely store it immediately.

Pre-Requisite: Enable API Key Usage in `appsettings.json`

To use API Keys in VDM connection profiles, you must update the WebReports configuration file.

Enable API Keys

Add the following section to your appsettings.json file:

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

Tip: If you’re placing this at the end of the file, do not add a comma after the final bracket. JSON files will fail to load if trailing commas are incorrectly placed.

Where Can You Create a WebReports API Key?

API Keys are created on the API Keys page under the Management section of the WebReports navigation bar. Only users with the Admin role can create API keys.

Video Tutorial

Steps to Create a WebReports API Key

Step 1: Log In to WebReports

Use an account with the Admin role.

Step 2: Open the API Keys Page

Click the Management tab from the navigation bar, then click API Keys to access the API Key management screen.

Step 3: Click "Add"

Click the Add button to begin generating your key.

Step 4: Copy the Secret API Key

The Secret Key will display once. Copy it and store it securely.

Important: You will not be able to view the key again. It’s essential to save it now.

Step 5: Enter Application Name

This identifies the application that will use the key (e.g., “BW Web API”).

Step 6: Enter a Description

Provide a description of how or where this API Key will be used.

Step 7: Specify Allowed Hosts

Enter allowed DNS names or IP addresses (separate multiple values with a semicolon).

Tip: Use an asterisk (*) to allow all hosts (not recommended for production environments).

Optional Step: Assign to a User

If the API Key is for a specific user's VDM connection, select the user it applies to.

Step 10: Click "Add API Key"

Once all fields are filled, click Add API Key to finalize the setup.

Article Summary

Creating an API Key in WebReports allows applications or users to securely authenticate with the WebReports API. With proper configuration in appsettings.json, these keys can also be used in VDM connection profiles—enabling secure, flexible access to reporting functionality.

Use Case: An organization wants to allow a reporting tool to pull data from WebReports without storing usernames or passwords. Assigning an API Key tied to a specific user ensures secure, role-based access with host restrictions.