The install ends one of its own sessions. The archive record lands through the driver like any other; nothing lands after it.

POST

/sessions/{id}/archive

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

Authorizations

install_key

Parameters

Path Parameters

required

A stream id: 72 hex chars, the shard then the owner digest.

string

The session to end.

Responses

202

The archive record landed; nothing lands on the session again.

401

No install key, or one no install answers.

404

No such session under this install.

409

The session was already archived.