POST /api/lunasa/config/backups

POST /api/lunasa/config/backups

This resource will create back up of the appliance configuration data, and save it to the appliance file system

Parameters

description

Specifies the description of the backup.

Use: Required

JSON Schema:

    Object
    type:string
    minLength: 1
    maxLength: 128
    pattern: ^[a-zA-Z0-9_.,:{}[]()@ -]*$

factoryConfig

Specifies the flag to backup with factory default configuration.

Use: Required

JSON Schema:

    Object
    type:boolean
        false = do not backup with factory default configuration.
        true = do backup with factory default configuration.

service

Specifies the name of the service.
Valid values: network,ssh,ntls,syslog,ntp,snmp,users,system,webserver,ctc,all

Use: Not Required

JSON Schema:

    Object
    type:string
    minLength: 3
    maxLength: 12
    pattern: ^(network|ssh|ntls|syslog|ntp|snmp|users|system|webserver|ctc|all|cluster|ismigration)$

Responses

200

Success

400

SYSCONF_CONFIG_SERVICE_NAME_INVALID

Specified service name is invalid.

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

SYSCONF_CONFIG_FAILED_TO_CREATE_BACKUP

Unable to create backup.

403

FRAMEWORK_CRITICAL_OPERATION_RUNNING

Critical Operation currently in Progress.

Example Request

    POST
    https://1.2.3.4:8443/api/lunasa/config/backups
    {
      "description": "Configuration Backup 20-11-21",
      "factoryConfig": false,
      "service":"webserver"
    }

Example Response

    {
        "configurationBackupFile": "webserver_Config_20211025_1134"
    }