...
- 400: User name is missing
- 404: User does not exist
5.16 Public key
5.15.1 Get current public key
This resource provides the current public key that is used for uploading data through scp/sftp.
Request
GET /intercept/publickeySuccess response
Header
Content-Type: "text/plain"
Body
| Code Block |
|---|
{
"ssh-rsa": "AAAAB3NzaC1yc2EAAAADAQABAAACAQ..."
} |
Status
200
5.17 Snapshot resource
A Snapshot Resource is defined by the base path: /intercept/snapshots
...
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.
...
Success Response
Body
| Code Block |
|---|
{
"senderName": "Example User",
"senderAddress": "test@example.com"
} |
Fields
- senderName: the sender display name
- senderAddress: the sender email address
Status
...
Error Codes
See: API Concepts for general error information
...
"fingerprint": "75:5c:f9:c8:b6:f0:18:aa:23:ec:d9:67:56:ee:5f:c1", | The public key of remote server for upload in hexdecimal notation. | Yes if "action" is "SCP" or "SFTP" |
| "host": "upload.customer.net", | The FQDN or IP of the upload destination. | Yes if "action" is "SCP" or "SFTP" |
| "port": 22, | The network port of the upload destination. | Yes if "action" is "SCP" or "SFTP" |
| "path": "/upload/dir", | The path on remote server to store the upload file. | Yes if "action" is "SCP" or "SFTP" |
| "username": "uploaduser" | The username used when connecting to remote server. | Yes if "action" is "SCP" or "SFTP" |
| }, | - | - |
| "start": "2016-08-01T14:00:00Z", | The start date (interval) of the messages to be exported. | Yes if "type" is "MAILBOX" |
| "end": "2016-08-14T15:00:00Z", | The end date (interval) of the messages to be exported. | Yes if "type" is "MAILBOX" |
| "error": { | The error object, set if status is 'failed'. | No, Service managed. |
| "errorCode": <string>, | The error code of the failure. | No, Service managed. |
| "errorMessage": <string> | The error message for the failure. | No, Service managed. |
| } | - | - |
| } | - | - |
5.17.2 Snapshot status
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
5.17.4 List all available snapshots
This resource is used to query the list of all available snapshots.
Request
GET /intercept/snapshots?status=availableSucess response
Body
| 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.
Request
GET /intercept/snapshots/{snapshotId}Sucess response
Body
| 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.
Request
GET /intercept/snapshots/{snapshotId}/statusSucess response
Body
| 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".
Request
GET /intercept/snapshots/{snapshotId}/dumpSuccess response
Header
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.
Request
DELETE /intercept/snapshots/{snapshotId}Sucess response
Status
204
...
5.18 Brand Permission History
...