Execute DiagnosticsWorkflow

POST

///v1/workflow/ngc/diagnostics

Run diagnostic commands against network devices and attach results to a ticketing issue

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.

Request

This endpoint expects an object.

commandslist of stringsRequired

Diagnostic command catalog names to run on each device.

device_idslist of stringsRequired

Nautobot identifiers of the devices to diagnose.

include_tech_supportbooleanOptionalDefaults to false

Whether to collect a technical-support bundle from each device.

issue_keystringOptionalDefaults to

Issue key to update; empty enables ticketless mode.

ticketing_platformstringOptionalDefaults to

Ticketing platform to update; empty enables ticketless mode.

userstringOptionalDefaults to

Engineer username or email, populated from request authentication when omitted.

Response

Successful Response

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

Errors

422

Unprocessable Entity Error

$	curl -X POST /v1/workflow/ngc/diagnostics \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"commands": [
>	"show interfaces status",
>	"show version",
>	"show running-config"
>	],
>	"device_ids": [
>	"device-1234",
>	"device-5678"
>	]
>	}'