Troupeby AliveDocsSign in

Reference

catalog

What can be requested: device types and OS versions per platform. Index · shared schemas · errors.

ProcedureSummaryRESTMCP toolStability
catalog.deviceTypesList the device types and profiles for a platformGETcatalog_deviceTypesstable
catalog.osVersionsList the OS versions for a platform, with installed and an install commandGETcatalog_osVersionsstable

catalog.deviceTypes

List the device types and profiles for a platform

RESTGET /v1/catalog/device-types (input as query parameters)
RPC/rpc/v2/catalog/deviceTypes
MCPtool catalog_deviceTypes; hints: read-only, idempotent
Authdevices:read
Tenancynone
Troupe Cloudanswered by the control plane
Stabilitystable, since 1.0

Input:

TypeScript
{ platform: PlatformId }

Output:

TypeScript
{ deviceTypes: DeviceType[] }

Errors: U, E, CAPABILITY_UNSUPPORTED.

Named types: DeviceType, PlatformId.

catalog.osVersions

List the OS versions for a platform, with installed and an install command

RESTGET /v1/catalog/os-versions (input as query parameters)
RPC/rpc/v2/catalog/osVersions
MCPtool catalog_osVersions; hints: read-only, idempotent
Authdevices:read
Tenancynone
Troupe Cloudanswered by the control plane
Stabilitystable, since 1.0

Input:

TypeScript
{ platform: PlatformId }

Output:

TypeScript
{ osVersions: OsVersion[] }

Errors: U, E, CAPABILITY_UNSUPPORTED.

Named types: OsVersion, PlatformId.

esc

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