...
- 400: User name is missing
- 404: User does not exist
5.16 Public key
5.17 Snapshot resource
A Snapshot Resource is defined by the base path: /intercept/snapshots
The representations of a snapshot are meta data (for creation and management) and the binary data of the snapshot itself.
The creation of the snapshot dump is an asynchronous operation and the current status can be queried with corresponding snapshot ID.
5.17.1 Snapshot metadata
Snapshot metadata is represented by JSON, the represntation can differ between the different REST calls.
JSON representation
| Field | Description | Mandatory |
|---|---|---|
| { | - | - |
| "snapshotId": <string>, | The unique id that qualified a snapshot, will be a UUID. | Yes |
| "username": <string>, | The name of the user for which the snapshot is created. | Yes |
| "type": <string>, | The type of the snapshot, one of: MAILBOX, CALENDAR, CONTACTS. | Yes |
| "action": <string>, | The type of upload action, one of: SCP, SFTP, DOWNLOAD. | Yes |
| "status": <string>, | The current snapshot status, see status table below. | Yes |
| "lastChanged": <timestamp>, | The timestamp when the last status change happened. | No. Service managed. |
| "ssh": { | The ssh connection object. | Yes if "action" is "SCP" or "SFTP" |
Request
GET /v1/mailboxes/<userName>/senderFields
All listed parameters are mandatory.
- userName: the unique ID of the user (String)
Success Response
Body
| Code Block |
|---|
{
"senderName": "Example User",
"senderAddress": "test@example.com"
} |
Fields
- senderName: the sender display name
- senderAddress: the sender email address
Status
200
Error Codes
See: API Concepts for general error information
- 400: User name is missing
- 404: User does not exist
5.18 Brand Permission History
...