Search

REST API (v2)

Version 26.1.9516

REST API (v2)

The CData Sync REST API v2 provides a modern, resource-oriented interface for programmatically managing and automating Sync environments. The API exposes core platform objects (for example, workspaces, connections, jobs, transformations, pipelines, and events) through versioned, REST-compliant endpoints. With this API, you can use RESTful API calls to perform the same tasks that you do in the Sync administration console. For example, you can use the API to query configured connections, jobs, and job history. You can start or cancel jobs, as well.

REST API v2 is composed of seven separate APIs, each of which corresponds to a major component of the Sync application: workspace management, job management, transformation management, pipeline management, event management, connection management, and user management. The tables below outline the endpoints that are available for each of these components, along with supported methods and descriptions of their purposes.

Connection Management API

Endpoint Supported Methods Description
List All Connections GET Retrieves a list of all connections within a specific workspace.
Update Connection PUT Updates an existing connection.
Delete Connection DELETE Deletes an existing connection.
Test Connection POST Tests an existing connection.
Reset Credentials POST Resets OAuth or stored credentials for a connection.
List All Connection Tables GET Retrieves the list of tables available in a connection.
List All Table Columns GET Retrieves the list of columns for a specific table.
List Connection Logs GET Retrieves logs for a connection.
Download Logs POST Downloads a specific connection log file.

Event Management API

Endpoint Supported Methods Description
List All Events GET Retrieves a list of all pipeline events.
Retrieve Event GET Retrieves a specified pipeline event.
Create Event POST Creates an event in a specific pipeline.
Update Event PUT Updates an event in a pipeline.
Delete Event DELETE Deletes an event in a pipeline.

Job Management API

Endpoint Supported Methods Description
List All Jobs GET Retrieves a list of all jobs in an existing workspace.
Create Job POST Creates a job in a specified workspace.
Update Job PUT Updates an existing job.
Delete Job DELETE Deletes an existing job.
Execute Job POST Starts execution of a job.
Cancel Job POST Cancels a running job.
Job History GET Retrieves the current execution status of a job.
Job Status GET Retrieves the current execution status of a job.
List All Job Tasks GET Retrieves all tasks within a job.
Retrieve Task GET Retrieves a specific task.
Add Task POST Adds a task to a job.
Update Task PUT Updates a job task.
Delete Task DELETE Deletes a job task.
Move Task POST Reorders the position of a task within a job.
Last Task Run GET Retrieves the last run of all tasks in a job.
Task History GET Retrieves the execution history for a job task.

Transformation Management API

Endpoint Supported Methods Description
List All Transformations GET Lists all transformations in a specified workspace.
Create Transformation POST Creates a transformation in a specified workspace.
Update Transformation PUT Updates an existing transformation.
Delete Transformation DELETE Deletes a transformation.
Execute Transformation POST Starts execution of a transformation.
Transformation History GET Retrieves the execution history for a transformation.
Transformation Status GET Retrieves the current execution status of a transformation.
List All Tasks Tasks GET Retrieves a list of all transformation tasks.
Retrieve Task Details GET Retrieves the details for a specific task in a transformation.
Add Task POST Add a task to a transformation.
Update Task PUT Updates an existing task in a transformation.
Delete Task DELETE Deletes a transformation task.
Move Task POST Reorders the position of a task within a transformation.

Pipeline Management API

Endpoint Supported Methods Description
List All Pipelines GET Retrieves a list of all pipelines in a specified workspace.
Retrieve Pipeline Details GET Retrieves details for a specified pipeline.
Create Pipeline POST Creates a pipeline in a specified workspace.
Update Pipeline PUT Updates an existing pipeline.
Delete Pipeline DELETE Deletes a pipeline.
Execute Pipeline POST Starts execution of a pipeline.
Cancel Pipeline POST Cancels a running pipeline.
Pipeline History GET Retrieves the execution history for a pipeline.
Pipeline Status GET Retrieves the current execution status of a pipeline.
Pipeline Steps GET Retrieves a list of pipeline steps.
Create Pipeline Steps POST Retrieves a list of pipeline steps.
Update Pipeline Steps PUT Updates pipeline step.
Delete Pipeline Steps DELETE Deletes a pipeline step.
Move Step POST Reorders the position of a step within a pipeline.

User Management API

Endpoint Supported Methods Description
List All Users GET Lists all Sync users.
Retrieve User GET Retrieves a specified user.
Create User POST Creates a Sync user.
Update User PUT Updates a Sync user.
Delete User DELETE Deletes a Sync user.

Workspace Management API

Endpoint Supported Methods Description
List All Workspaces GET Lists all workspaces that the authenticated user can access.
Retrieve Workspace Details GET Retrieves details for a specific workspace.
Create Workspace POST Creates a new workspace.
Update Workspace Name PUT Updates the name of an existing workspace.
Delet Workspace DELETE Deletes a workspace.