A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. An API is a set of definitions and protocols for building and integrating application software. It is sometimes referred to as a contract between an information provider and an information user—establishing the content required from the consumer (the call) and the content required by the producer (the response).

Access to data via the REST endpoint follows the path below:

Swagger Doc

API documentation is available on Swagger via https://<your conduit app url>/swagger-ui/index.html

For using Swagger with authentication please see the section below “Swagger Authentication”.

Code examples for API usage

Also you can check out our samples GitHub repo for code examples of using the REST endpoint to query Conduit connectors.

REST Authentication

REST Authentication is possible only via Bearer/JWT token, regardless of Active Directory or Conduit authentication. 

A connector in Conduit can have either Basic Authentication (internal user + password) or Active Directory Authentication (AD user + Access Token).

Token Authentication

Pass credentials directly with a Bearer authorization header, then pass the access token you copy from Conduit Management Console (i.e. Username → Access Token → Copy Access Token). 

Example: Retrieve all databases

curl -X GET "https://dev-conduit.westus.cloudapp.azure.com/query/metadata/all" -H  "accept: application/json" -H  "Authorization: Bearer <conduit_access_token>"

Swagger Authentication

While using Swagger samples, please mind the access token authentication when passing the credentials. 

The following API categories are now available:

Data Catalog API

Query API

Metadata API

Query audit API

Authentication API

Service Management API

Materialization audit API

Materialization API

Query Cache API

In order to have all requests already authenticated, please click on the Authorize button and provide the access token which is available at the below path in the Conduit management console: 

  • Username → Access Token → Copy Access Token; 

  • Use the authentication API to obtain the access token (only available with internal user account credentials). 



Related articles