Deleting a connection

Connections in Decodable ingest data from a data source or send data out to a data sink. You can find a full list of available connectors here, or in the navigation menu on the left.

There are four ways to manage connections in Decodable: the Decodable web app, the CLI, and the API. Within the CLI you may use an imperative approach, or a declarative YAML-based declarative approach.

  • Web App

  • CLI

  • Declarative Resource Management

  • API

  1. Navigate to the Connections page.

  2. From the list of connections shown, click on the connection that you want to delete.

  3. Click the … icon in the top-right of the page and select Delete.

    delete connection
To use the CLI, download it and then login to your account

Use decodable connection delete to delete a connection.

For example, to delete connection 670e5b5a run:

decodable connection delete 670e5b5a

You can use YAML to define your resources, including connections, and manage them in a declarative way. This approach integrates seamlessly with CI/CD tools and allows for management of large-scale and complex resources. To learn more about using declarative resource management consult the documentation pages.

For connectors that support multiple streams the decodable scan command is an easy way to generate YAML files. You can also use decodable query to return the definitions of existing resources in YAML as a starting point for creating new ones.

The Decodable CLI provides access to the declarative resource management commands. Before using the examples below, download the Decodable CLI and login to your account.

To delete a connection using declarative resource management you use the decodable query command in conjunction with a suitable filter to identify the connection you want to delete, combined with the --operation delete flag.

The delete operation isn’t reversible. Caution should be exercised when using it.

For example, to delete the connection called my-datagen-connection run:

$ decodable query --name my-datagen-connection --operation delete
---
kind: connection
name: my-datagen-connection
id: 670e5b5a
result: deleted

You can also pass the same YAML that was used in the declarative apply command if you want to delete all resources defined within it:

$ decodable query connection.yaml --operation delete
---
kind: connection
name: my-datagen-connection
id: e71b7cd3
result: deleted
---
kind: stream
name: my-datagen-connection_source
id: 59b26bc8
result: deleted

For more details and examples refer to the decodable query documentation.

Use a DELETE HTTP call to the connections/{id} Decodable control plane API endpoint. The URL of the endpoint is based on your account name:

https://<account name>.api.decodable.co/v1alpha2/connections/

Below is an example of deleting a connection with id 0abe42bf under the account called acme-01 and using curl to make the HTTP call.

You will need an access token in order to authenticate your REST call to the Decodable API endpoint. You can obtain this using the Decodable CLI's decodable token access command. For more details see here.

 
curl -X DELETE "https://acme-01.api.decodable.co/v1alpha2/connections/0abe42bf" \
     -H "Authorization: Bearer $(decodable token access)"