Update an appliance's IP, credentials, network role, site, and web protocol

post

http://127.0.0.1:8080/appliance

Updates an existing appliance's configuration in Orchestrator. Modifiable fields include IP address, credentials, network role, site assignment, and web protocol. Password is encrypted before storage. If the network role is changed to hub, the appliance is automatically added to all regional overlays. Site changes trigger orchestration updates for all appliances.

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

Appliance configuration data to update. All fields are optional except when changing specific settings.

Request body for updating appliance configuration. All fields are optional - only include fields you want to modify.

string

Management IP address or hostname of the appliance. Hostnames are resolved to IP addresses.

networkRole

string

enum

Network topology role assignment. Changing to hub adds appliance to all regional overlays.

Allowed:

password

length between 1 and 128

Authentication password for appliance access. Must be 1-128 characters without spaces or special characters (& < > " '). Encrypted before storage.

userName

string

Authentication username for appliance access.

webProtocolType

integer

enum

Communication protocol between Orchestrator and appliance.

Allowed:

site

string

Site name for appliance grouping. Changing site triggers orchestration updates for all appliances and IPSec UDP port conflict resolution.

Responses

Language

Loading…

Response

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

application/json

200Appliance updated successfully. Returns empty response body.

400Bad request due to validation errors, missing parameters, or invalid data.

500Internal server error during appliance update.