Execute SiteCableValidationWorkflow

POST

///v1/workflow/ngc/site_cable_validation

Validate cable connections for all devices in a site against intended topology

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.

sitestringRequired

Site containing the network devices to validate.

device_type_idslist of stringsOptionalDefaults to []

Device type identifiers used to filter network devices.

raise_for_invalidbooleanOptionalDefaults to false

Whether invalid cabling should fail the workflow.

roleslist of stringsOptionalDefaults to

["tan-bbr","cin-core","cin-spine","cin-leaf","tan-core","tan-spine","tan-leaf","smn-core","smn-spine","smn-leaf","smn-aggleaf"]

Device roles used to filter the selected network devices.

statuslist of stringsOptionalDefaults to ["active","provisioning"]

Device statuses used to filter the selected network devices.

tenantstringOptionalDefaults to nsv

Tenant used to filter the selected network devices.

Response

Successful Response

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

Errors

422

Unprocessable Entity Error

$	curl -X POST /v1/workflow/ngc/site_cable_validation \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"site": "datacenter-west-01"
>	}'