Backup Protocol¶
Backup Protocol API¶
GET .
Directory index.
Returns: <null>
UPLOAD blob
Upload binary blob file.
Required properties:
encoded-size <integer> (12 - 16777260) : | |
---|---|
Encoded blob size. | |
file-name <string> : | |
Backup archive name. |
Returns: <null>
UPLOAD dynamic_chunk
Upload a new chunk.
Required properties:
digest <string> : | |
---|---|
Chunk digest (SHA256). | |
encoded-size <integer> (13 - 16777260) : | |
Encoded chunk size. | |
size <integer> (1 - 16777216) : | |
Chunk size. | |
wid <integer> (1 - 256) : | |
Dynamic writer ID. |
Returns: <null>
POST dynamic_close
Close dynamic index writer.
Required properties:
chunk-count <integer> (1 - N) : | |
---|---|
Chunk count. This is used to verify that the server got all chunks. | |
csum <string> : | Digest list checksum. |
size <integer> (1 - N) : | |
File size. This is used to verify that the server got all data. | |
wid <integer> (1 - 256) : | |
Dynamic writer ID. |
Returns: <null>
POST dynamic_index
Create dynamic chunk index file.
Required properties:
archive-name <string> : | |
---|---|
Backup archive name. |
Returns: <null>
PUT dynamic_index
Append chunk to dynamic index writer.
Required properties:
digest-list <array> : | |
---|---|
Chunk digest list. | |
offset-list <array> : | |
Chunk offset list. | |
wid <integer> (1 - 256) : | |
Dynamic writer ID. |
Returns: <null>
POST finish
Mark backup as finished.
Returns: <null>
UPLOAD fixed_chunk
Upload a new chunk.
Required properties:
digest <string> : | |
---|---|
Chunk digest (SHA256). | |
encoded-size <integer> (13 - 16777260) : | |
Encoded chunk size. | |
size <integer> (1 - 16777216) : | |
Chunk size. | |
wid <integer> (1 - 256) : | |
Fixed writer ID. |
Returns: <null>
POST fixed_close
Close fixed index writer.
Required properties:
chunk-count <integer> (0 - N) : | |
---|---|
Chunk count. This is used to verify that the server got all chunks. Ignored for incremental backups. | |
csum <string> : | Digest list checksum. |
size <integer> (0 - N) : | |
File size. This is used to verify that the server got all data. Ignored for incremental backups. | |
wid <integer> (1 - 256) : | |
Fixed writer ID. |
Returns: <null>
POST fixed_index
Create fixed chunk index file.
Required properties:
archive-name <string> : | |
---|---|
Backup archive name. | |
size <integer> (1 - N) : | |
File size. |
Optional properties:
reuse-csum <string> : | |
---|---|
If set, compare last backup’s csum and reuse index for incremental backup if it matches. |
Returns: <null>
PUT fixed_index
Append chunk to fixed index writer.
Required properties:
digest-list <array> : | |
---|---|
Chunk digest list. | |
offset-list <array> : | |
Chunk offset list. | |
wid <integer> (1 - 256) : | |
Fixed writer ID. |
Returns: <null>
DOWNLOAD previous
Download archive from previous backup.
Required properties:
archive-name <string> : | |
---|---|
Backup archive name. |
Returns: <null>
UPLOAD speedtest
Test upload speed.
Returns: <null>
Reader Protocol API¶
GET .
Directory index.
Returns: <null>
UPLOAD blob
Upload binary blob file.
Required properties:
encoded-size <integer> (12 - 16777260) : | |
---|---|
Encoded blob size. | |
file-name <string> : | |
Backup archive name. |
Returns: <null>
UPLOAD dynamic_chunk
Upload a new chunk.
Required properties:
digest <string> : | |
---|---|
Chunk digest (SHA256). | |
encoded-size <integer> (13 - 16777260) : | |
Encoded chunk size. | |
size <integer> (1 - 16777216) : | |
Chunk size. | |
wid <integer> (1 - 256) : | |
Dynamic writer ID. |
Returns: <null>
POST dynamic_close
Close dynamic index writer.
Required properties:
chunk-count <integer> (1 - N) : | |
---|---|
Chunk count. This is used to verify that the server got all chunks. | |
csum <string> : | Digest list checksum. |
size <integer> (1 - N) : | |
File size. This is used to verify that the server got all data. | |
wid <integer> (1 - 256) : | |
Dynamic writer ID. |
Returns: <null>
POST dynamic_index
Create dynamic chunk index file.
Required properties:
archive-name <string> : | |
---|---|
Backup archive name. |
Returns: <null>
PUT dynamic_index
Append chunk to dynamic index writer.
Required properties:
digest-list <array> : | |
---|---|
Chunk digest list. | |
offset-list <array> : | |
Chunk offset list. | |
wid <integer> (1 - 256) : | |
Dynamic writer ID. |
Returns: <null>
POST finish
Mark backup as finished.
Returns: <null>
UPLOAD fixed_chunk
Upload a new chunk.
Required properties:
digest <string> : | |
---|---|
Chunk digest (SHA256). | |
encoded-size <integer> (13 - 16777260) : | |
Encoded chunk size. | |
size <integer> (1 - 16777216) : | |
Chunk size. | |
wid <integer> (1 - 256) : | |
Fixed writer ID. |
Returns: <null>
POST fixed_close
Close fixed index writer.
Required properties:
chunk-count <integer> (0 - N) : | |
---|---|
Chunk count. This is used to verify that the server got all chunks. Ignored for incremental backups. | |
csum <string> : | Digest list checksum. |
size <integer> (0 - N) : | |
File size. This is used to verify that the server got all data. Ignored for incremental backups. | |
wid <integer> (1 - 256) : | |
Fixed writer ID. |
Returns: <null>
POST fixed_index
Create fixed chunk index file.
Required properties:
archive-name <string> : | |
---|---|
Backup archive name. | |
size <integer> (1 - N) : | |
File size. |
Optional properties:
reuse-csum <string> : | |
---|---|
If set, compare last backup’s csum and reuse index for incremental backup if it matches. |
Returns: <null>
PUT fixed_index
Append chunk to fixed index writer.
Required properties:
digest-list <array> : | |
---|---|
Chunk digest list. | |
offset-list <array> : | |
Chunk offset list. | |
wid <integer> (1 - 256) : | |
Fixed writer ID. |
Returns: <null>
DOWNLOAD previous
Download archive from previous backup.
Required properties:
archive-name <string> : | |
---|---|
Backup archive name. |
Returns: <null>
UPLOAD speedtest
Test upload speed.
Returns: <null>