Deregister a Connection

Remove a connection via the API

DELETE /data/object/{connectionKey}

Required Immuta permission: APPLICATION_ADMIN

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
}