...
A Snapshot status is based on it's current state of processing.
| Status | Description |
|---|---|
pending | After creation is pending and waits for execution. |
| dumping | The dump is in progress. |
| dumped | The dump was generated and waits for upload. |
| uploading | The upload is in progress. |
| available | Indicates, that the upload was successful and snapshot is available. |
| failed | Indicates, that an error happens on dumping or uploading operation. |
deleted | The snapshot has been deleted by an operator |
5.17.3 Create a snapshot of a user's mailbox
This resource is used to create a snapshot of the data of a given user.
Request
POST /intercept/snapshotsBody
| Mailbox snapshot | Calendar snapshot | Contacts snapshot |
|---|---|---|
| { "username" : "someone", "type": "mailbox", "action": "scp", "ssh": { "fingerprint": "75:5c:f9:c8:b6:f0:18:aa:23:ec:d9:67:56:ee:5f:c1.", "host": "upload.customer.net", "port": 22, "path": "/upload/dir", "username": "uploaduser" }, "start": "2016-08-01T14:00:00Z", "end": "2016-08-14T15:00:00Z" } | { | { "username" : "someone", "type": "contacts", "action": "scp", "ssh": { "fingerprint": "75:5c:f9:c8:b6:f0:18:aa:23:ec:d9:67:56:ee:5f:c1.", "host": "upload.customer.net", "port": 22, "path": "/upload/dir", "username": "uploaduser" } } |
Sucess response
Header
Location=/intercept/snapshots/{1a2b3c-..}Body
| Code Block |
|---|
{
"snapshotId": "1a2bCc-..",
"username" : "someone",
"type": "calendar",
"action": "scp",
"status": "pending"
"lastChanged": 123456..
} |
Status
200
5.17.4 List all available snapshots
This resource is used to query the list of all available snapshots.
...
| Code Block |
|---|
[
{
"snapshotId": <string>,
"username": <string>,
"type": <string>,
"action": <string>,
"status": "available"
"lastChanged": <timestamp>
},
{
"snapshotId": <string>,
"username": <string>,
...
}
] |
Status
200
5.
...
17.5 Get snapshot metadata
This resource is used to query the metadata of a specific snapshot.
...
| Code Block |
|---|
{
"snapshotId": <string>,
"username": <string>,
"type": <string>,
"action": <string>,
"status": <string>,
"lastChanged": <timestamp>,
"error": <object>
} |
Status
200
5.17.6 Get snapshot status
This resource is used to query the current status of a given snapshot.
...
| Code Block |
|---|
{
"status": <string>
} |
Status
200
5.17.7 Get snapshot dump
This resource provides the binary dump of the snapshot if snapshot was created with action "DOWNLOAD".
...
Content-Type: application/octet-stream
Body
byte[]
Status
200
5.17.8 Delete snapshot of mailbox
This resource is used to mark a snapshot as deleted. If the snapshot was of type 'Download', the actual dump is deleted too.
...