Configuration Backup and Restore

It is recommended that you read the following topics before proceeding:

  • Thunder Backup and Restore

  • Administrative Scopes

  • Role Based Access Control

Harmony Controller provides capability to take backup of Thunder devices and store in controller. These backups can be restored back to the Thunder devices as needed. APIs described in this page are for accomplishing tasks related to Thunder configuration backup and restore.

Following APIs are available:

  • Initiate/Schedule backup of a device

  • List backups taken from a device

  • Restore backup on a device

  • Delete an existing backup

Calling APIs

Please refer to Getting Started section for details of calling Harmony APIs.

These APIs are for Provider Scope, hence it is not required to include tenant name in HTTP header. User calling the API should have sufficient privileges for the action. In absence of sufficient privileges HTTP 403 response is returned.

Description

defaultDescription

Security

Secured (HTTP Basic Authentication)

DEFAULT

DELETE ``/api/v2/hpcapi/v3/uuid/{backup-uuid}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

backup-uuid

path

Yes

string

Generated path parameter. Example value =’uuid’

Request

Headers

provider: Generated header parameter. Example value ='root'

Responses

200

Type: Backup_delete_response

Example:

{
    "response": {
        "status": "somestring"
    }
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hocapi/v1/provider/{provider-name}/device/{device-name}/backup/``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

device-name

path

Yes

string

Generated path parameter. Example value =’device name’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

backup

No

Backup

{
    "backup": {
        "data": {
            "description": "somestring",
            "device-name": "somestring"
        },
        "schedule": {
            "is-repeating": true
        }
    }
}

Responses

200

Type: Backup_response

Example:

{
    "job": {
        "id": "somestring",
        "name": "somestring",
        "next-run-time": "somestring"
    }
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hocapi/v1/provider/{provider-name}/device/{device-name}/_restore/``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

device-name

path

Yes

string

Generated path parameter. Example value =’device name’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

restore

No

Restore

{
    "restore": {
        "backup-id": "somestring",
        "device-name": "somestring"
    }
}

Responses

200

Type: Restore_response

Example:

{
    "workflow": {
        "uuid": "somestring"
    }
}

Security

Security Schema

Scopes

Secured

Data Structures

Backup Model Structure

Name

Required

Type

Format

Properties

Description

data

No

Data

schedule

No

Schedule

Backup Delete Response Model Structure

Name

Required

Type

Format

Properties

Description

response

No

Response

Backup Payload Model Structure

Name

Required

Type

Format

Properties

Description

backup

No

Backup

Backup Response Model Structure

Name

Required

Type

Format

Properties

Description

job

No

Job

Data Model Structure

Name

Required

Type

Format

Properties

Description

description

No

string

device-name

No

string

Job Model Structure

Name

Required

Type

Format

Properties

Description

id

No

string

name

No

string

next-run-time

No

string

Response Model Structure

Name

Required

Type

Format

Properties

Description

status

No

string

Restore Model Structure

Name

Required

Type

Format

Properties

Description

backup-id

No

string

device-name

No

string

Restore Payload Model Structure

Name

Required

Type

Format

Properties

Description

restore

No

Restore

Restore Response Model Structure

Name

Required

Type

Format

Properties

Description

workflow

No

Workflow

Schedule Model Structure

Name

Required

Type

Format

Properties

Description

is-repeating

No

boolean

Workflow Model Structure

Name

Required

Type

Format

Properties

Description

uuid

No

string