Execute BackupWorkflow

POST

///v1/workflow/ngc/backup

Backup network device configuration to the Config Store and NVIDIA Config Manager plugin

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.

device_idstringRequired

Identifier of the network device to back up.

triggerenumRequired

Reason the backup workflow was started.

intended_config_commit_idstring or nullOptional

Config Store commit containing the intended configuration.

userstring or nullOptional

User that requested the backup.

user_domainstring or nullOptional

Domain of the user requesting the backup.

workflow_idstring or nullOptional

Identifier of the parent workflow, if any.

Response

Successful Response

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

Errors

422

Unprocessable Entity Error

$	curl -X POST /v1/workflow/ngc/backup \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"device_id": "router-nyc-01",
>	"trigger": "SCHEDULED"
>	}'