apis » npm.backup » 1.0
Backup and Restore v1.0
Created Nov 12, 2024 at 09:55 PM

Resource: backup

A single backup of a device

http://{device}/api/npm.backup/1.0/backups/items/{id}
  • JSON
    • {
  "backup_time": integer,
  "description": string,
  "hostname": string,
  "id": string,
  "model": string,
  "serial": string,
  "size": integer,
  "status": string,
  "status_message": string,
  "sw_version": string
}
    Property Name Type Description Notes
    backup <object> A single backup of a device
    backup.backup_time <integer> The time the backup was taken, in Unix epoch seconds Read-only; Optional;
    backup.description <string> Description of this backup Optional;
    backup.hostname <string> Hostname of the device the backup was created on Read-only; Optional;
    backup.id <string> The backup ID Read-only; Optional;
    backup.model <string> Model of the device the backup was created on Read-only; Optional;
    backup.serial <string> Serial of the device the backup was created on Read-only; Optional;
    backup.size <integer> The size of the backup, in bytes Read-only; Optional;
    backup.status <string> Status of the backup Read-only; Optional; Values: completed, started, failed, uploading;
    backup.status_message <string> Extra information about backup status Optional;
    backup.sw_version <string> The software version running when the backup was created Read-only; Optional;

    backup: delete

    DELETE http://{device}/api/npm.backup/1.0/backups/items/{id}
    Response Body

    On success, the server does not provide any body in the responses.

    backup: download

    Retrieve the backup file. This link returns binary data. 

    GET http://{device}/api/npm.backup/1.0/backups/items/{id}/file
    Response Body

    On success, the server does not provide any body in the responses.

    backup: get

    GET http://{device}/api/npm.backup/1.0/backups/items/{id}
    Response Body

    Returns a backup data object.

    backup: restore

    Begin a restore of this backup. The system will reboot as part of this operation. 

    POST http://{device}/api/npm.backup/1.0/backups/items/{id}/restore
    Request Body

    Do not provide a request body.

    Response Body

    Returns a restore_status data object.

    Resource: backups

    List of all available backups

    http://{device}/api/npm.backup/1.0/backups
  • JSON
    • {
  "items": [ backup ]
}
    Property Name Type Description Notes
    backups <object> List of all available backups
    backups.items <array of <backup>> All available backups Optional;
    backups.items[items] <backup> A single backup of a device

    backups: create

    POST http://{device}/api/npm.backup/1.0/backups
    Request Body

    Provide a backup data object.

    Response Body

    Returns a backup data object.

    backups: get

    GET http://{device}/api/npm.backup/1.0/backups
    Response Body

    Returns a backups data object.

    backups: reset_factory

    Reset the appliance to its initial configuration, wiping out all configuration, logs, and data 

    POST http://{device}/api/npm.backup/1.0/backups/reset_factory
    Request Body

    Do not provide a request body.

    Response Body

    Returns a restore_status data object.

    backups: upload

    Upload a backup file. A backup file is obtained from the download link on a backup resource. The accepted content-type is application/octet-stream. 

    POST http://{device}/api/npm.backup/1.0/backups/upload
    Request Body

    Do not provide a request body.

    Response Body

    Returns a backup data object.

    Resource: restore_status

    Status of the latest restore operation

    http://{device}/api/npm.backup/1.0/restore_status
  • JSON
    • {
  "last_restore_time": integer,
  "status": string,
  "status_message": string
}
    Property Name Type Description Notes
    restore_status <object> Status of the latest restore operation
    restore_status.last_restore_time <integer> Time of the last restore, in Unix epoch seconds. Will be 0 if no restore has ever been performed. Optional;
    restore_status.status <string> Restore status Optional; Values: not_run, started, failed, completed, completed_with_errors;
    restore_status.status_message <string> Further status information Optional;

    restore_status: get

    GET http://{device}/api/npm.backup/1.0/restore_status
    Response Body

    Returns a restore_status data object.