Rotate under the tenant owner's console token or this install's current key.

POST

/installs/{id}/key

const url = 'https://api.canopyhq.dev/installs/example/key';
const options = {method: 'POST', 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 POST \
  --url https://api.canopyhq.dev/installs/example/key \
  --header 'Authorization: Bearer <token>'

Authorizations

console_token
install_key

Parameters

Path Parameters

required

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

string

The install whose key changes.

Responses

200

The tenant owner or vendor holding the current install key receives a new key once. The old key stops resolving immediately.

application/json

A freshly issued key, returned once and never stored in plain text.

object

key

required

string

Example^generated

{
  "key": "example"
}

403

Only the tenant owner or this install’s current key may rotate.

404

The tenant has no such install, or it was deleted.

409

Another key-management operation won; the owner may retry.