File Backup API

Hono Command: command//<name>:<namespace>/req//backup

Ditto Message:

Name	Value	Description
topic	<name>/<namespace>/things/live/messages/backup	Information about the affected Thing and the type of operation
path	/features/BackupAndRestore/inbox/messages/backup	A path to the BackupAndRestore Feature, it’s message channel, and backup command
Headers		Additional headers
response-required	true/false	If response is required
content-type	application/json	The content type
correlation-id	UUID	Used for correlating protocol messages, the same correlation-id as the sent back response message
Value
correlationID	UUID	Identifier of the backup file
providers		The providers of the restore command
options
backup.dir		A local directory, to be backed up
https.url		The URL for restoring the backed up directory

Example : Back up a directory.

Topic: command//edge:device/req//backup

{
	"topic":"edge/device/things/live/messages/backup",
	"headers":{
		"response-required":true,
		"content-type":"application/json",
		"correlation-id":"<UUID>"
	},
	"path":"/features/BackupAndRestore/inbox/messages/backup",
	"value":{
		"correlationID":"upload-id-1704439450#n",
		"providers":{},
		"options":{
			"backup.dir":"/var/tmp/backup",
			"https.url":""
		}
	}
}

Hono Command : command//<name>:<namespace>/res//backup

Ditto Message:

Name	Value	Description
topic	<name>/<namespace>/things/live/messages/backup	Information about the affected Thing and the type of operation
path	/features/BackupAndRestore/outbox/messages/backup	A path to the BackupAndRestore Feature, it’s message channel, and backup command
Headers		Additional headers
content-type	application/json	The content type
correlation-id	<UUID>	The same correlation id as the request message
Status		Status of the backup operation

Example : Successful response of a backup operation.

Topic: `command//edge:device/res//backup``

{
	"topic":"edge/device/things/live/messages/backup",
	"headers":{
		"content-type":"application/json",
		"correlation-id":"<UUID>"
	},
	"path":"/features/BackupAndRestore/outbox/messages/backup",
	"status":204
}

Hono Command: command//<name>:<namespace>/req//restore

Ditto Message:

Name	Value	Description
topic	<name>/<namespace>/things/live/messages/restore	Information about the affected Thing and the type of operation
path	/features/BackupAndRestore/inbox/messages/restore	A path to the BackupAndRestore Feature, it’s message channel, and restore command
Headers		Additional headers
response-required	true/false	If response is required
content-type	application/json	The content type
correlation-id	UUID	Used for correlating protocol messages, the same correlation-id as the sent back response message
Value
correlationID	other UUID	Identifier of the restored file
providers		Storage provider, one of aws, azure, generic
options		Options are specific for each provider
backup.dir		A local directory, which to be backed up and then uploaded, using a storage provider of choice and temporary credentials
https.url		The URL for restoring the backed up directory

Example : Restore a backup from a storage provider.

Topic: command//edge:device/req//restore

{
	"topic":"edge/device/things/live/messages/restore",
	"headers":{
		"response-required":true,
		"content-type":"application/json",
		"correlation-id":"<UUID>"
	},
	"path":"/features/BackupAndRestore/inbox/messages/restore",
	"value":{
		"correlationID":"upload-id-1704439450#n",
		"providers":{},
		"options":{
			"backup.dir":"/var/tmp/backup",
			"https.url":"https://raw.githubusercontent.com/eclipse-kanto/container-management/main/containerm/pkg/testutil/config/"
		}
	}
}

Hono Command : command//<name>:<namespace>/res//restore

Ditto Message:

Name	Value	Description
topic	<name>/<namespace>/things/live/messages/restore	Information about the affected Thing and the type of operation
path	/features/BackupAndRestore/outbox/messages/restore	A path to the BackupAndRestore Feature, it’s message channel, and restore command
Headers		Additional headers
content-type	application/json	The content type
correlation-id	<UUID>	The same correlation id as the request message
Status		Status of the operation restore

Example : Response of a successful restore operation.

Topic: `command//edge:device/res//restore``

{
	"topic":"edge/device/things/live/messages/restore",
	"headers":{
		"content-type":"application/json",
		"correlation-id":"<UUID>"
	},
	"path":"/features/BackupAndRestore/outbox/messages/restore",
	"status": 204
}