Book a demo

API Changes

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 /data/crawl/{objectPath*}.

Step 3: If the parent schema has activateNewChildren: false,

PUT /data/settings/{objectPath*} with settings: isActive: 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 /data/crawl/{objectPath*}.

Step 3: If the parent schema has activateNewChildren: false,

PUT /data/settings/{objectPath*} with settings: isActive: 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 /data/crawl/{objectPath*}

Delete a data source

DELETE /dataSource/{dataSourceId}

DELETE /data/object/{objectPath*}

Bulk delete data sources

  • PUT /dataSource/bulk/{delete}

  • DELETE /api/v2/data/{connectionKey}

  • DELETE /{technology}/handler/{handlerId}

  • DELETE /dataSource/{dataSourceId}

DELETE /data/object/{objectPath*}

Enable a single data source

PUT /dataSource/{dataSourceId}

PUT /data/settings/{objectPath*} with settings: isActive: true

Bulk enable data sources

PUT /dataSource/bulk/{restore}

PUT /data/settings/{objectPath*} with settings: isActive: true

Disable a single data source

PUT /dataSource/{dataSourceId}

PUT /data/settings/{objectPath*} with settings: isActive: false

Bulk disable data sources

PUT /dataSource/bulk/{disable}

PUT /data/settings/{objectPath*} with settings: isActive: 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 /data/connection

Update an integration/connection

PUT /integrations/{integrationId}

PUT /data/connection/{connectionKey}

Delete an integration/connection

DELETE /integrations/{integrationId}

DELETE /data/object/{connectionKey}

Delete and update a data dictionary

  • DELETE /dictionary/{dataSourceId}

  • POST /dictionary/{dataSourceId}

  • PUT /dictionary/{dataSourceId}

No substitute. Data source dictionaries are automatically generated based on information from your data platform.

Update a data source owner

  • PUT /dataSource/{dataSourceId}/access/{id}

  • DELETE /dataSource/{dataSourceId}/unsubscribe

PUT /data/settings/{objectPath*} with settings: dataOwners

Response to a data source owner request

  • POST /subscription/deny

  • POST /subscription/deny/bulk

PUT /data/settings/{objectPath*} with settings: dataOwners

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

  • 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 /data/object/{objectPath}.

PreviousBefore You BeginNextFAQ

Last updated

Was this helpful?