NylorunDocsBeta
Management APITenant

Get the Tenant's status

GET
/v1/tenant

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

Response Body

Readiness, model, sandboxes, streams and counts

application/json
  1. response
tenant*
path*string
Length1 <= length
checks*
model*|
agents*array<>
counts*
sandbox*
harness?
execution?
streams?
import { createAdmin } from "@nylorun/admin";const admin = createAdmin();const status = await admin.tenant.status();
{  "tenant": {    "id": "string",    "name": "string",    "createdAt": "string",    "updatedAt": "string",    "schemaVersion": 0  },  "path": "string",  "checks": {    "store": true,    "scheduler": true,    "model": true,    "schema": true  },  "model": {    "configured": false  },  "agents": [    {      "agentId": "string"    }  ],  "counts": {    "sessions": 0,    "runningSessions": 0,    "uncertainEffects": 0  },  "sandbox": {    "backend": "string",    "retained": 0  },  "harness": {    "mode": "in-process",    "connected": 0,    "workspace": true  },  "execution": {    "stuckInvocations": [      {        "id": "string",        "status": "string",        "service": "string",        "handler": "string",        "key": "string",        "retryCount": 0,        "lastFailure": "string",        "modifiedAt": "string"      }    ],    "error": "string"  },  "streams": {    "reachable": true,    "basin": {      "ready": true,      "failures": 0,      "lastError": "string"    },    "generation": 0,    "relay": {      "active": true,      "pendingTxs": 0,      "pendingRows": 0,      "confirmed": "string",      "reconciliations": 0,      "lastError": "string",      "lagBytes": 0    }  }}