HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. applianceExtraInfo

Save appliance extra information

post
http://127.0.0.1:8080/appliance/extraInfo

Creates or updates the extra information (location, contact, overlay settings) for a specified appliance. The location object with a valid country is required. This action is logged in the audit trail.

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

Appliance extra information including location, contact, and overlay settings.

Additional appliance metadata.

contact
object

Contact information for the appliance administrator.

location
object

Physical location of the appliance.

overlaySettings
object

Appliance-specific overlay settings.

Responses
204

Extra information saved successfully. No content returned.

401

Unauthorized - Authentication required

403

Forbidden - User does not have READ_WRITE permission

Updated about 11 hours ago

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

Updated about 11 hours ago

Did this page help you?