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

Restore appliance configuration from a backup

post
http://127.0.0.1:8080/appliance/restore

Initiates an asynchronous restore of appliance configuration from a previously created backup. The backup file ID can be obtained using GET /appliance/backup?nePk=<appliance_id>. The operation uploads the backup to the appliance, triggers restore, and reboots the appliance. Requires appliance software version 7.2.0.0 or higher (6.2.8.0 for 6.2.x branch, 7.1.1.0 for 7.1.x branch). Poll GET /appliance/restore/status?nePk=

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

Request body containing the backup file ID to restore from.

Request body for restoring appliance configuration from a backup file.

int64
required
≥ 1

Unique database identifier of the backup file to restore from. Obtain this ID from GET /appliance/backup?nePk=<appliance_id>.

Responses

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?