Execute SitePasswordRotationWorkflow

POST

///v1/workflow/ngc/site_password_rotation

Rotate passwords across all devices in a site with coordinated deployment

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.

locationstringRequired>=1 character

Location containing the devices to update.

selected_secretstringRequired

Name of the managed secret containing the replacement password.

roleslist of stringsOptionalDefaults to []

Device roles used to filter the selected network devices.

statuslist of stringsOptionalDefaults to ["Active","Provisioned"]

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/site_password_rotation \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"location": "New York Data Center",
>	"selected_secret": "ngc-site-password-rotation-2024"
>	}'