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’s 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 below path:
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
A connector in Conduit can have either Basic Authentication (internal user + password) or Active Directory Authentication (AD user + Access Token).
While using CURL commands please mind the following types of authentication when passing credentials:
basic authentication (for conduit internal users)
token authentication (for Active Directory users)
Basic Authentication
If you pass credentials directly in a Basic authorization header, then you have to base64 encode your credentials in the shape of:
a) user:pass if you’re using Conduit credentials (i.e. Conduit internal users)
b) user:token if you’re using AD credentials, do not use the AD password but use access token that was copied from Conduit Management Console (i.e. Username → Access Token → copy)
In case of a) the API will authenticate and authorize you against all connectors with Conduit internal users or display those with Anonymous Authentication.
Example: Retrieve all databases
curl -X GET "https://dev-conduit.westus.cloudapp.azure.com/query/metadata/all" -H "accept: application/json" -H "authorization: Basic ZGVtby11c2VyQGJwY3MuY29tOmRlbW8tdXNlci1wYXNzd29yZA=="
In case of b) the API will authenticate and authorize you against connectors with Active Directory (i.e. AD) or display those with Anonymous Authentication.
Example: Retrieve all databases
curl -X GET "https://dev-conduit.westus.cloudapp.azure.com/query/metadata/all" -H "accept: application/json" -H "authorization: Basic c2FtcGxlLWFkLXVzZXJAYnBjcy5jb206ZXlKaGJHY2lPaUpJVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SmpjbVZoZEdWa1FYUWlPbTUxYkd3c0ltTnlaV0YwWldSQ2VTSTZiblZzYkN3aVpYaHdhWEpoZEdsdmJsOTBjeUk2TVRZeU16YzNNRGN3T1N3aVpXMWhhV3dpT2lKellXMXdiR1V0ZFhObGNrQmljR056TG1OdmJTSXNJbkp2YkdWeklqcGJJbUZ1WVd4NWMzUWlMQ0poWkcxcGJpSmRMQ0pzWVhOMFRtRnRaU0k2SWxWelpYSWlMQ0poWkVGalkyVnpjeUk2ZXlKemRXSnpZM0pwY0hScGIyNU9ZVzFsSWpvaVlXRmtYMlJsZGlJc0luTmxjM05wYjI1SlpDSTZJalUxWkdaaU9UUTFMVFl4WWpndE5ERmhPQzA0WVRVMkxUWXdObU16TjJVMlpEQmtPU0o5TENKd1lYTnpkMjl5WkNJNmJuVnNiQ3dpWm1seWMzUk9ZVzFsSWpvaVUyRnRjR3hsSW4wLjlucmdGVnpCWjhJNllJR29EdGpQZEVGaThQeWxLcW5yWjJQLVZQdUwtVE0="
Token Authentication
If you 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 following types of authentication when passing credentials:
basic authentication
access token authentication
In order to have all requests already authenticated, please click on the Authorize button and provide the following combination of credentials:
a) Conduit credentials - internal Conduit users
user: <conduit internal username>
password: <conduit internal user password>
b) Active Directory credentials - Active Directory users
user: <AD username>
password: <access token>
Conduit Management Console → Username → Access Token → Copy Access Token
If the Swagger users wants to authenticate each request one by one (i.e. without clicking the Authorize button) then use the same values as described above for the pair (username, password) upon the Sign in popup.