Validate deployment configuration

post

http://127.0.0.1:8080/deployment/validate

Validates a deployment configuration against a managed appliance. The configuration is first checked for port profile compatibility (firewall harden options vs. appliance software version), then sent to the appliance for full validation. Returns whether the configuration is valid and if applying it would require a reboot. Requires 'read-write' role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

^\d+\.NE$

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

Body Params

Deployment configuration to validate. Must include modeIfs, dpRoutes, and sysConfig.

Deployment configuration object used for validation and for applying changes. This is the same structure returned by GET /deployment (minus read-only fields like scalars and mgmtIfData). To apply deployment changes to an appliance, POST this object to POST /appliance/rest?nePk={nePk}&url=deployment (see the 'appliance' tag). The entire deployment object must be sent — there is no partial update.

dhcpFailover

object

List of dhcp failover settings configured on the interfaces

dpRoutes

array of objects

required

dpRoutes*

modeIfs

array of objects

required

modeIfs*

sysConfig

object

required

Appliance system configuration including deployment mode and lookup tables for resolving numeric IDs used in modeIfs[].applianceIPs[]. Contains ifLabels (label ID-to-name mapping), zones[] (zone ID-to-name mapping), vrfs[] (VRF segment ID-to-name mapping), and roles[] (role ID-to-name mapping). To identify interfaces by name (e.g., find all 'Guest' interfaces): first find the numeric ID in the appropriate sysConfig lookup table, then match it against the corresponding field in applianceIPs[].

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication required. No valid session.

403

Insufficient permissions. Requires 'read-write' role.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Validation completed. Check 'err' field for validation errors and 'rebootRequired' for reboot impact.

400Invalid request. Caused by missing/invalid nePk, non-existent appliance, or port profile validation failure.

500Internal server error communicating with the appliance.