connections_delete
DELETE
/connections/{id}
const url = 'https://api.canopyhq.dev/connections/example';const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://api.canopyhq.dev/connections/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
The connection to delete.
Responses
Section titled “Responses”The connection was deleted.
No console token, or one that did not verify.
Only an owner of the tenant may delete a connection.
The tenant owns no connection by that name.
Installs still reference this connection. Remove their references or delete those installs first; nothing is cascaded.
Media typeapplication/json
The installs that must stop referencing a resource before it can be deleted.
object
installs
required
Array<string>
message
required
string
Examplegenerated
{ "installs": [ "example" ], "message": "example"}