All pages
Powered by GitBook
1 of 1

Deregister a Connection

Data API reference guide

Required Immuta permission: APPLICATION_ADMIN

To deregister a connection from Immuta, do the following:

  1. Generate a script to clean up any Immuta-managed resources from your data platform.

  2. Delete the connection in Immuta.

  3. Run the script in Databricks Unity Catalog or Snowflake to clean up any Immuta-managed resources from your environment.

Step 1: Generate the cleanup script

POST /integrations/{id}/scripts/delete

Creates a script to remove Immuta-managed resources from your data platform.

curl -X 'POST' \
    'https://www.organization.immuta.com/integrations/1/scripts/delete' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: 846e9e43c86a4ct1be14290d95127d13f'

Path parameters

Attribute
Description
Required

id integer

The integration ID. Use the GET /integrations endpoint to list all your integrations and their IDs.

Yes

Response

The response returns the script that you will run in your Databricks Unity Catalog or Snowflake environment. Copy it for later.

Step 2: Delete the connection in Immuta

DELETE /data/object/{connectionKey}

Delete the given connection and all its child objects.

curl -X 'DELETE' \
    'https://<your-immuta-url>/data/object/yourConnectionKey' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <your-bearer-token>' \

Path parameters

Attribute
Description
Required

connectionKey string

The key to uniquely identify the connection. This is the same as the display name of the connection in the Immuta UI.

Yes

Response schema

Attribute
Description

connectionKey string

The key to uniquely identify the connection.

childCount integer

The number of child objects of the data object that were deleted.

Example response

{
  "objectPath": ['yourConnectionKey'],
  "childCount": 5
}

Step 3: Run the cleanup script in your data platform

Using the copied generated cleanup script from earlier, run it in your Snowflake or Databricks Unity Catalog environment as a privileged user.

The script will remove any objects that were initially created during the Register a connection process.