Page Contents

BackupAndRestore

BackupAndRestore¶

BackupAndRestore - BackupNow¶

Adds a backup of DB configuration at the current time.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/backupnow

Parameter

Field	Label in UI	Type	Description
report_backup	Report Backup	boolean	Create a backup for the generated report files. Value can be set as “true” or “false”. Mandatory Field

Request Example

{
    "data": {
        "report_backup": "true"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

BackupAndRestore - CreateConfigBackup¶

Back up the configuration details of Fabric-enabled LogPoint and all of its collectors/fetchers.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore

Parameter

Field	Label in UI	Type	Description
authorized_keys	Public Key	String	Part of Encryption key of the li-admin . Obtain the value of this parameter using Certificate - List API. Optional Field
conf_scheduled_retention	Backup Retention	int	Retention period for the configuration backup in days. Value must be >=1. Mandatory only when “schedule_configuration_backup” is set as “on”. Optional Field
conf_scheduled_utc_hour	Backup Run Hour	int	Scheduled time for configuration backup in UTC hour. Mandatory only when “schedule_configuration_backup” is set as “on”. Optional Field
report_backup	Report Backup	String	Create a backup for the generated report files. Value can be “on” or “off”. Set the value as “on” only when you want to back up the configuration immediately. Optional Field
schedule	Interval	String	Interval for the configuration backup. Takes values as daily/weekly/monthly. Mandatory only when “schedule_configuration_backup” is set as “on”. Optional Field
schedule_configuration_backup	Schedule Backup	String	Value can be set as “on” or “off”. Set the value as “on” when you want to schedule a backup of your configuration. Mandatory Field
weekday	-	String	Values can be Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday to schedule a configuration backup in certain days of a week. Mandatory only if the schedule is set to weekly. Optional Field

Request Example

{
    "data": {
        "authorized_keys": "asdfgh",
        "conf_scheduled_retention": 30,
        "conf_scheduled_utc_hour": 0,
        "report_backup": "on",
        "schedule": "weekly",
        "schedule_configuration_backup": "on",
        "weekday": "sunday"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

BackupAndRestore - CreateLogsChecksumBackup¶

Back up the logs, index of the logs and the checksum of the logs of the Fabric-enabled LogPoint.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/logchecksumbackup

Parameter

Field	Label in UI	Type	Description
all_time	All Days	String	Backs up all the logs till date. The all_time parameter or the oldest_time parameter is required only when the value of “schedule_log_backup” is “on”. Value of the all_time parameter can be “on” or “off”. Optional Field
authorized_keys	Public Key	String	Part of Encryption key. Obtain the value of this parameter using Certificate - List API. Optional Field
backup_repos	Repos to Backup	String	Comma separated repo ids or empty. Mandatory if schedule_log_backup is “on”. Obtain the value of the required Repo id using Repos - List API. Optional Field
full_backup	Full Backup	String	Backs up logs and checksum of the desired repos in desired time. Value can be set as “on” or “off”. If the value of full_backup is set as “on”, “scheduled_log_backup” will also be “on” by default. For the value to be “off”, both “schedule_log_backup” and “full_backup” must be “off”. Optional Field
oldest_time	-	String	Backs up the logs from the given time period. The all_time parameter or the oldest_time parameter is required only when the value of “schedule_log_backup” is “on”. Value of the oldest_time parameter must in dd/mm/yyyy format. Optional Field
schedule_log_backup	Schedule Backup	String	Backs up logs and checksum of the desired repos in desired time. Value can be set as “on” or “off”. For the value to be “off”, both “schedule_log_backup” and “full_backup” must be “off”. Optional Field
scheduled_retention	Backup Retention	int	integer greater than 0. Should be provided only if schedule_log_backup is ‘on’.Retention period for the scheduled backup of Logs Checksum in days. Value must be an integer >=1. Mandatory only when the value of “schedule_log_backup” is set to “on”. Optional Field
scheduled_utc_hour	Backup Run Hour	int	Time in UTC hour, from when the backup is started. Integer [0-23]. Mandatory if either ‘full_backup’ is “on” or ‘schedule_log_backup’ is “on”. Optional Field

Request Example

{
    "data": {
        "all_time": "on",
        "authorized_keys": "asdfgh",
        "backup_repos": "547c04fbd8aaa47389671bb2,547c04fbd8aaa47389671bb3",
        "full_backup": "on",
        "oldest_time": "11/11/2017",
        "schedule_log_backup": "off",
        "scheduled_retention": 30,
        "scheduled_utc_hour": 0
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

BackupAndRestore - Get¶

Fetches any backup data with given ID.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing back up data id .

Success Response

{
    "_permission": true,
    "backupdate": "2018-04-18-00-00-00",
    "created_date": "2018/04/18 04:28:19",
    "filename": "logs_2018-04-18.backup",
    "id": "0cafc41559b591b304364e5b9a00d7ed",
    "name": "_logpoint",
    "size": 18160,
    "type": "logs"
}

BackupAndRestore - List¶

Lists all backup data.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore

Success Response

[
    {
        "_permission": true,
        "backupdate": "2018-04-18-00-00-00",
        "created_date": "2018/04/18 04:28:19",
        "filename": "logs_2018-04-18.backup",
        "id": "0cafc41559b591b304364e5b9a00d7ed",
        "name": "_logpoint",
        "size": 18160,
        "type": "logs"
    },
    {
        "_permission": true,
        "backupdate": "2018-04-13-00-00-00",
        "created_date": "2018/04/17 10:17:52",
        "filename": "logs_2018-04-13.backup",
        "id": "34121959c00fbbc3061ad3921f7a7d7d",
        "name": "_logpoint",
        "size": 8830,
        "type": "logs"
    }
]

BackupAndRestore - ListSettings¶

Lists the backup and restore settings.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/settings

Success Response

[
    {
        "authorized_keys": "",
        "backup_repos": [],
        "conf_scheduled_retention": 365,
        "conf_scheduled_utc_hour": 0,
        "from_ts": "",
        "id": "5ac6ef2ed8aaa47316027a3f",
        "schedule": "Monthly",
        "schedule_configuration_backup": "off",
        "schedule_log_backup": "off",
        "scheduled_retention": 365,
        "scheduled_utc_hour": 2,
        "weekday": ""
    }
]

BackupAndRestore - LogChecksumBackupNow¶

Back up the logs, index of the logs and the checksum of the logs of the Fabric-enabled LogPoint at current time.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/logchecksumbackupnow

Request Example

{
    "data": {}
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

BackupAndRestore - RefreshList¶

Updates the list of backup schedule.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/refreshlist

Request Example

{
    "data": {}
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

BackupAndRestore - Restore¶

Restores the backup data.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/{id}/restore

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing back up data id . Mandatory Field

Request Example

{
    "data": {}
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

BackupAndRestore - Trash¶

Deletes any backup data with given ID.

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/BackupAndRestore/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing back up data id . Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?