NylorunDocsBeta
Management APITenant

Reset the Tenant

POST
/v1/tenant/reset

Deletes its sessions, its sandboxes, or both, after draining or cancelling the turns in progress. The Tenant stays open.

Authorization

managementKey
headerAuthorizationBearer <token>

A management key of the Tenant (role management): it reaches the Management API (/v1/tenant/*) and /v1/me, as itself, never for a subject. Issued only on the Tenant's machine (nylorun-operate keys put <id> --role management) or from NYLORUN_MANAGEMENT_KEY_FILE. Never accepted from a browser (Origin).

Header Parameters

Nylorun-Protocol*string

The protocol version, 8

Request Body

application/json
  1. body
requestId*string
Length1 <= length
scope*string
Value in"sessions""sandboxes""all"
activeWork*string
Value in"drain""cancel"

Response Body

Reset

application/json
  1. response
ok*true
Value intrue
import { createAdmin } from "@nylorun/admin";const admin = createAdmin();await admin.tenant.reset({ scope: "sessions", activeWork: "cancel" });
{  "ok": true}

Seed the Tenant's configuration PUT

Sets each setting the Tenant does not have yet; keeps the ones it has.

List the Tenant's keys GET

Every key of the Tenant by name, with its role (`application`, `management` or `studio`) and when it was issued. Keys themselves are never shown again.