Execute MultiDeployWorkflow

POST

///v1/workflow/ngc/multi_deploy

Deploy configurations to multiple devices by role with batching and approval workflow

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.

rolestringRequired

Device role used to select network devices for deployment.

commit_confirmbooleanOptionalDefaults to true

Whether to use commit-confirmed mode when the platform supports it.

locationstring or nullOptional

Location used to filter the selected network devices.

max_batch_sizeintegerOptionalDefaults to 10

Maximum number of devices included in each deployment batch.

statuslist of strings or nullOptional

Device statuses used to filter the selected network devices.

tenantstring or nullOptional

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/multi_deploy \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"role": "edge-router"
>	}'