Skip to main content
CData Sync provides a REST API that complies with the OData 4.0 standard. 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 v1 is composed of three separate APIs, each of which corresponds to a major component of the Sync application: job 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

EndpointSupported MethodsDescription
ConnectionsGET, POST, PUT, DELETERetrieves or updates the configuration for existing connections or adds a new connection to the application.
TestConnectionPOSTTests a previously created connection.
GetConnectionTablesPOSTRetrieves a list of tables for a connection.
GetConnectionTableColumnsPOSTRetrieves a list of columns for a table.

​
Job Management API

EndpointSupported MethodsDescription
JobsGET, POST, PUT, DELETERetrieves or updates the configuration for existing job or creates a new job.
TransformationsGET, POST, PUT, DELETERetrieves or updates the configuration for existing transformations or creates a new transformation.
TasksGET, POST, PUT, DELETERetrieves or updates the configuration for existing tasks of a job or adds a new task to a job.
GetJobStatusPOSTRetrieves the status of all jobs or the status of each query within a specified job.
ExecuteJobPOSTStarts the specified job.
ExecuteQueryPOSTExecutes a subset of queries within a job. You must specify both the job and the query.
CancelJobPOSTCancels a currently running job.
HistoryGETRetrieves the history of previous job runs.
GetJobLogPOSTRetrieves logs from a previous job run or job runs.

​
User Management API

EndpointSupported MethodsDescription
UsersGET, POST, PUTCreates, retrieves, or updates Sync users.
CreateUsersPOSTCreates multiple Sync users.