Introduction

Welcome to the Data Integration API Documentation.

Using the Data Integration API, you can automate any single or group operations you perform in the Data Integration console. You can create, execute, and delete Rivers, create DataFrames, automate processes, and more. The Data Integration API is structured around REST. It accepts JSON request bodies, returns JSON responses, and employs conventional HTTP response codes, authentication, and verbs to access and use data through HTTP requests.

Refer to the Legacy API documentation.

Authorization

Data Integration API Token

To generate a Bearer token, refer to the Data Integration docs on Help Docs.

Every bearer token is a combination of account, environment, and scopes attached. Every time the token is provided, the API compares its scopes with the request required scope. If the scope is not valid, an insufficient permissions (403) response code returned.

Scopes

A scope is a combination of the entity in Data Integration, and the operation allowed to perform on the entity.

The entity can be any entity available via the API, for example - connection. An operation can be one of specific operations allowed for each scope. For example: list or edit. Therefore, listing connections scope will be set as connection:list. Ensure that the Bearer token has the right scopes attached for the needed requests.