Deregister a Host

To deregister a host from Immuta, do the following:

Step 1: Generate the cleanup script

POST /integrations/{id}/scripts/delete

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

Required Immuta permission: APPLICATION_ADMIN

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

AttributeDescriptionRequired

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 host in Immuta

DELETE /data/object/{connectionKey}

Delete the given host and all its child objects.

Required Immuta permission: INFRASTRUCTURE_ADMIN or DATA_OWNER on the object

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

AttributeDescriptionRequired

connectionKey string

The key to uniquely identify the host connection.

Yes

Response schema

AttributeDescription

connectionKey string

The key to uniquely identify the host 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 host process.

Last updated

Self-managed versions

2024.32024.22024.1

Copyright © 2014-2024 Immuta Inc. All rights reserved.

#141: DSIA API Updates

Change request updated