Execute BatchDeployWorkflow

POST

///v1/workflow/ngc/batch_deploy

POST

/v1/workflow/ngc/batch_deploy

$ curl -X POST /v1/workflow/ngc/batch_deploy \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "batch_devices": [
>     {
>       "device": {
>         "device_type": "switch",
>         "id": "dev-12345",
>         "name": "core-switch-01",
>         "platform": "arista-eos",
>         "primary_ip4": "10.0.1.10",
>         "primary_ip6": "fd00::10",
>         "role": "core",
>         "site": "datacenter-nyc"
>       }
>     }
>   ],
>   "diff_group": {
>     "devices": [
>       {
>         "device": {
>           "device_type": "switch",
>           "id": "dev-12345",
>           "name": "core-switch-01",
>           "platform": "arista-eos",
>           "primary_ip4": "10.0.1.10",
>           "primary_ip6": "fd00::10",
>           "role": "core",
>           "site": "datacenter-nyc"
>         }
>       }
>     ],
>     "diff_content": "interface Ethernet1\n  description Uplink to Router\n  no shutdown\n!",
>     "diff_hash": "a3f5c9d8e7b4f1a2c3d6e8f9b0a1c2d3"
>   },
>   "parent_workflow_id": "wf-7890abcd-1234-5678-9abc-def012345678"
> }'

1 {
2   "href": "https://temporal.example.com/workflows/wf-7890abcd-1234-5678-9abc-def012345678",
3   "id": "wf-7890abcd-1234-5678-9abc-def012345678"
4 }

Deploy configurations to a batch of devices with shared diff content

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.

batch_deviceslist of objectsRequired

Devices whose configurations will be deployed in this batch.

diff_groupobjectRequired

Shared configuration diff for the device batch.

parent_workflow_idstringRequired

Identifier of the parent multi-deploy workflow.

batch_numberinteger or nullOptional

Sequence number of this batch within the parent workflow.

commit_confirmbooleanOptionalDefaults to true

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

Response

Successful Response

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

Errors

422

Unprocessable Entity Error