installs_delete

DELETE

/installs/{id}

const url = 'https://api.canopyhq.dev/installs/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/installs/example \
  --header 'Authorization: Bearer <token>'

Authorizations

console_token

Parameters

Path Parameters

required

Opaque; never the key, never anything the vendor chose.

string

The install to delete.

Responses

204

The install and its key are revoked. The key now receives 401 and cannot open sessions. Session tokens live 15 minutes and are renewed with the install key. An open session keeps its landed config and its log, and keeps answering under its current token, but cannot renew once the install is gone: it ends when its token expires.

401

No console token, or one that did not verify.

403

Only an owner of the tenant may delete an install.

404

The tenant has no such install.