Troupeby AliveDocsSign in

Reference

runtime

Discovery, health and administration of the runtime itself. Index · shared schemas · errors.

ProcedureSummaryRESTMCP toolStability
runtime.versionIdentify the server and its contract range. The only unauthenticated read; it says nothing about devices.GET—stable
runtime.capabilitiesReport contract features, enabled platforms and their capabilities, and limitsGET—stable
runtime.statusReport daemon health: sessions, the device inventory, supervisors and restart counts, governor level, leaksGET—stable
runtime.hostInfoReport the host: OS, arch, RAM and disk, GUI session, profile, resolved toolchain paths and versions, limitsGET—stable
runtime.doctorRun read-only environment checks (troupe doctor --json). Failures come back as results; they are not thrown.GET—stable
runtime.shutdownStop the daemon. With live sessions and no force it refuses with CONFLICT.POST—stable
runtime.sweepFind leaked Troupe-owned devices and processes, and remove them when apply is set; anything not Troupe-owned is reported, never touchedPOST—stable

runtime.version

Identify the server and its contract range. The only unauthenticated read; it says nothing about devices.

RESTGET /v1/runtime/version (input as query parameters)
RPC/rpc/v2/runtime/version
MCPnot a tool (discovery and administration of the runtime); hints: read-only, idempotent
Authpublic: no credential; any credential sent is ignored
Tenancynone
Troupe Cloudanswered by the control plane
Stabilitystable, since 1.0

Input:

TypeScript
{}

Output:

TypeScript
{
  product: 'troupe'
  kind: 'runtime' | 'cloud' | …
  version: string
  contract: ContractInfo
  instanceId?: RuntimeInstanceId
}

Errors: U.

Named types: ContractInfo, RuntimeInstanceId.

runtime.capabilities

Report contract features, enabled platforms and their capabilities, and limits

RESTGET /v1/runtime/capabilities (input as query parameters)
RPC/rpc/v2/runtime/capabilities
MCPnot a tool (discovery and administration of the runtime); hints: read-only, idempotent
Authsession: any authenticated principal, no scope check
Tenancynone
Troupe Cloudanswered by the control plane
Stabilitystable, since 1.0

Input:

TypeScript
{}

Output:

TypeScript
{
  contract: ContractInfo
  features: string[]
  platforms: PlatformCapabilities[]
  limits: { maxTimeoutMs: integer; mcpMaxTimeoutMs: integer }
}

Errors: U.

Named types: ContractInfo, PlatformCapabilities.

runtime.status

Report daemon health: sessions, the device inventory, supervisors and restart counts, governor level, leaks

RESTGET /v1/runtime/status (input as query parameters)
RPC/rpc/v2/runtime/status
MCPnot a tool (discovery and administration of the runtime); hints: read-only, idempotent
Authruntime:read
Tenancynone
Troupe Cloudnot served; local runtime only
Stabilitystable, since 1.0

Input:

TypeScript
{}

Output:

TypeScript
RuntimeStatus

Errors: U.

Named types: RuntimeStatus.

runtime.hostInfo

Report the host: OS, arch, RAM and disk, GUI session, profile, resolved toolchain paths and versions, limits

RESTGET /v1/runtime/host-info (input as query parameters)
RPC/rpc/v2/runtime/hostInfo
MCPnot a tool (discovery and administration of the runtime); hints: read-only, idempotent
Authruntime:read
Tenancynone
Troupe Cloudnot served; local runtime only
Stabilitystable, since 1.0

Input:

TypeScript
{}

Output:

TypeScript
HostInfo

Errors: U.

Named types: HostInfo.

runtime.doctor

Run read-only environment checks (troupe doctor --json). Failures come back as results; they are not thrown.

RESTGET /v1/runtime/doctor (input as query parameters)
RPC/rpc/v2/runtime/doctor
MCPnot a tool (discovery and administration of the runtime); hints: read-only, idempotent
Authruntime:read
Tenancynone
Troupe Cloudnot served; local runtime only
Stabilitystable, since 1.0

Input:

TypeScript
{
  platforms?: PlatformId[]  // ≤ 16 items
}

Output:

TypeScript
{ ok: boolean; checks: DoctorCheck[] }

Errors: U.

Named types: DoctorCheck, PlatformId.

runtime.shutdown

Stop the daemon. With live sessions and no force it refuses with CONFLICT.

RESTPOST /v1/runtime/shutdown (input as a JSON body)
RPC/rpc/v2/runtime/shutdown
MCPnot a tool (discovery and administration of the runtime); hints: destructive
Authruntime:admin
Tenancynone
Troupe Cloudnot served; local runtime only
Stabilitystable, since 1.0

Input:

TypeScript
{
  force?: boolean  // default false
}

Output:

TypeScript
{
  endedSessions: integer  // ≥ 0
}

Errors: U, CONFLICT.

runtime.sweep

Find leaked Troupe-owned devices and processes, and remove them when apply is set; anything not Troupe-owned is reported, never touched

RESTPOST /v1/runtime/sweep (input as a JSON body)
RPC/rpc/v2/runtime/sweep
MCPnot a tool (discovery and administration of the runtime); hints: destructive
Authruntime:admin
Tenancynone
Troupe Cloudnot served; local runtime only
Stabilitystable, since 1.0

Input:

TypeScript
{
  apply?: boolean  // default false
}

Output:

TypeScript
{
  found: LeakItem[]
  removed: integer  // ≥ 0
}

Errors: U.

Named types: LeakItem.

esc

    Type to search every page, the protocol reference and the cloud API.