Legacy to Connections: API Changes

Understand the API endpoints that are deprecated after moving from legacy onboarding to connections and what endpoints to use instead

Deprecated endpoints

The following endpoints have been deprecated with connections. Use the recommended endpoint instead.

Action	Deprecated endpoint	Use this with connections instead
Create a single data source	POST /{technology}/handler POST /api/v2/data	Step 1: Ensure your system user has been granted access to the relevant object in the data platform. Step 2: Wait until the next object sync or manually trigger a metadata crawl using POST /api/connections/{connectionKey}/tasks with type DATA_OBJECT_SYNC in the payload. Step 3: If the parent schema has activateNewChildren: false, use PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: syncPolicy: true.
Bulk create data sources	POST /{technology}/handler POST /api/v2/data	Step 1: Ensure your system user has been granted access to the relevant object in the data platform. Step 2: Wait until the next object sync or manually trigger a metadata crawl using POST /api/connections/{connectionKey}/tasks with type DATA_OBJECT_SYNC in the payload. Step 3: If the parent schema has activateNewChildren: false, use PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: syncPolicy: true.
Edit a data source connection	POST /api/v2/data	No substitute. Data sources no longer have their own separate connection details but are tied to the parent connection.
Bulk edit data source's connections	PUT /{technology}/bulk POST /api/v2/data PUT /{technology}/handler/{handlerId}	No substitute. Data sources no longer have their own separate connection details but are tied to the parent connection.
Run schema detection (object sync)	PUT /dataSource/detectRemoteChanges	POST /api/connections/{connectionKey}/tasks with type DATA_OBJECT_SYNC in the payload
Delete a data source	DELETE /dataSource/{dataSourceId}	DELETE /api/connections/{connectionKey}/dataObjects/{id}
Bulk delete data sources	PUT /dataSource/bulk/{delete} DELETE /api/v2/data/{connectionKey} DELETE /{technology}/handler/{handlerId} DELETE /dataSource/{dataSourceId}	DELETE /api/connections/{connectionKey}/dataObjects/{id}
Enable a single data source	PUT /dataSource/{dataSourceId}	PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: syncPolicy: true
Bulk enable data sources	PUT /dataSource/bulk/{restore}	PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: syncPolicy: true
Disable a single data source	PUT /dataSource/{dataSourceId}	PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: syncPolicy: false
Bulk disable data sources	PUT /dataSource/bulk/{disable}	PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: syncPolicy: false
Edit a data source name	PUT /dataSource/{dataSourceId}	No substitute. Data source names are automatically generated based on information from your data platform.
Edit a display name	POST /api/v2/data/{connectionKey}	No substitute. Data sources no longer have their own separate connection details but are tied to the parent connection.
Override a host name	PUT /dataSource/{dataSourceId}/overrideHost	No substitute. Data sources no longer have their own separate connection details but are tied to the parent connection.
Create an integration/connection	POST /integrations	POST /api/connections
Update an integration/connection	PUT /integrations/{integrationId}	PATCH /api/connections/{connectionKey}
Delete an integration/connection	DELETE /integrations/{integrationId}	DELETE /api/connections/{connectionKey}
Delete and update data source columns	DELETE /dictionary/{dataSourceId} POST /dictionary/{dataSourceId} PUT /dictionary/{dataSourceId}	No substitute. Data source columns are automatically generated based on information from your data platform.
Update a data source owner	PUT /dataSource/{dataSourceId}/access/{id} DELETE /dataSource/{dataSourceId}/unsubscribe	PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: owners
Response to a data source owner request	POST /subscription/deny POST /subscription/deny/bulk	PATCH /api/connections/{connectionKey}/dataObjects/{id} with settings: owners
Manage data sources through the Immuta CLI	immuta datasource	Managing data sources through the Immuta CLI is not supported with connection-backed data sources. Use the connections API instead.

Impacted endpoints

If you have any automated actions using the following APIs, ensure you do the required change after the upgrade to ensure they continue working as expected.

Action	Impacted endpoint	Required change
Search for a data source	GET /dataSource/name/{dataSourceName} GET /dataSource	Data source names will change with the upgrade. Update {dataSourceName} in the request with the new data source name. Data sources names will change with the upgrade. Update the searchText in the payload with the new data source name.
Search schema names	GET /schemas	This endpoint will not search the schemas of connection data sources. Instead use the GET /api/connections/{connectionKey}/dataObjects/{id}.