API Data Provider - Online Help

Connecting to Parallel

The Parallel API uses API Key authentication via the x-api-key request header.

Using API Key Authentication

Your Parallel API key is required to create a connection. To obtain your API key:

  1. Log into your Parallel account at app.parallel.ai.
  2. Navigate to Settings or API Keys in your account dashboard.
  3. Generate or copy your API key.

After obtaining your API key, set the following connection properties:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Parallel API key.

Example connection string:

Profile=C:\profiles\Parallel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Usage Examples

MonitorEvents:

SELECT * FROM MonitorEvents WHERE MonitorId = 'mon_abc123'

Monitors:

SELECT * FROM Monitors

TaskRunInputs:

SELECT * FROM TaskRunInputs WHERE RunId = 'run_abc123'

TaskRunResults:

SELECT * FROM TaskRunResults WHERE RunId = 'run_abc123'

TaskRuns:

SELECT * FROM TaskRuns WHERE RunId = 'run_abc123'

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 The API key for the Parallel account. You can obtain your API key from your Parallel account dashboard.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655.0