API Data Provider - Online Help

Connecting to TestMonitor

TestMonitor uses token authentication to control access to the API.

Using Token Authentication

In order to authenticate to TestMonitor, you'll need to provide your API Key. To create a new API Key, you can go to My Account... > API > Create Token, in the top-right corner. Additionally, you will need to set the Domain, found in the domain name of your TestMonitor account. For example if your TestMonitor portal is acmeinc.testmonitor.com, then the Domain should be 'acmeinc'. Set both the API Key and Domain in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\TestMonitor.apip;ProfileSettings='Domain=acmeinc;APIKey=my_api_key';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your TestMonitor API Key (Personal Access Token).
Domain The domain for the TestMonitor account.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0