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

Apply preconfiguration to a managed appliance

post
http://127.0.0.1:8080/gms/appliance/preconfiguration/apply

Initiates asynchronous application of a preconfiguration to a managed appliance (an appliance visible in the Orchestrator tree). The operation parses the preconfiguration YAML, creates configuration tasks, and queues them for execution. Returns immediately with an actionGroupId for status polling via GET /gms/appliance/preconfiguration/apply.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
≥ 1

Unique identifier of the preconfiguration to apply. Must reference an existing preconfiguration created via POST /gms/appliance/preconfiguration.

string
required
^\d+\.NE$

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

Responses

Updated about 12 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 12 hours ago

Did this page help you?