HomeGuidesAPI Reference
API Reference

Apply wizard configuration to an appliance asynchronously.

Applies wizard configuration to an appliance asynchronously. Steps are executed in order: applianceImage, applianceExtraInfo, overlayRegion, coordinates, password, hostname, zones, vrfs, labels, loopback, ecLicense, deployment, subnets, approve, templates, overlays. Each step is optional - omit from wizardData to skip. Subnets are posted to /subnets for appliances <8.1.7 and /subnets2 for >=8.1.7. VRF support requires appliance version >=8.1.4. Poll completion status using GET /action/status?key={actionGroupId}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

Body Params

Wizard configuration containing optional steps. Include only the steps you want to apply.

Request body for applying wizard configuration.

string

Pre-configuration ID if using a preconfiguration template.

wizardData
object

Configuration data for each wizard step.

Responses

401

Unauthorized - User lacks READ_WRITE permission.

500

Internal server error - Failed to queue wizard apply or action processing error.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json