Get Diagnostics Commands

GET

///v1/parameter/diagnostics/commands

Return the diagnostics command catalog for the requested platform(s).

Pass one or more ?platform=<slug> query params (e.g. cumulus-linux). When no platform is given, commands from all platforms are returned. Commands that appear on multiple platforms are deduplicated by name.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Query parameters

platformlist of strings or nullOptional

Response

Successful Response

descriptionstring

namestring

Errors

422

Unprocessable Entity Error

1	[
2	{
3	"description": "Display detailed information about all network interfaces on the device.",
4	"name": "show interfaces"
5	},
6	{
7	"description": "Send ICMP echo requests to test network connectivity to a specified host.",
8	"name": "ping"
9	},
10	{
11	"description": "Trace the route packets take to a network host.",
12	"name": "traceroute"
13	},
14	{
15	"description": "Show the current software version and system information.",
16	"name": "show version"
17	},
18	{
19	"description": "Display the current active configuration of the device.",
20	"name": "show running-config"
21	}
22	]

$	curl /v1/parameter/diagnostics/commands \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"