Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Archive Manager 5.9.6 - RESTful API Service Guide

Table of Contents

Common rules Advanced searches

.../v1/searchQueries/schema.{format}

Supported HTTP method GET

.../v1/searchQueries.{format}

Supported HTTP method GET

Endpoint URI JSON response sample

.../v1/searchQueries/{advancedSearchId}.{format}

Supported HTTP method GET POST

JSON request sample JSON response sample

JSON request sample JSON response sample

Alert service global setting

.../v1/alertserviceglobalsetting/schema.{format}

Supported HTTP method GET

.../v1/alertserviceglobalsetting.{format}

Supported HTTP method GET PUT

.../v1/alertserviceglobalsetting/count.{format}

Supported HTTP method GET

Alert service policies

.../v1/alertservicepolicies/schema.{format}

Supported HTTP method GET

.../v1/alertservicepolicies.{format}

Supported HTTP method GET

.../v1/alertservicepolicies/count.{format}

Supported HTTP method GET

.../v1/alertservicepolicies/{alertServicePolicyId}.{format}

Supported HTTP method GET POST PUT Delete

Alert service queries

.../v1/alertservicequeries/schema.{format}

Supported HTTP method GET

.../v1/alertservicequeries.{format}

Supported HTTP method GET

.../v1/attachments/schema.{format}

Supported HTTP method GET

.../v1/attachments.{format}

Supported HTTP method GET

JSON response sample

.../v1/attachments/{checksum}

Supported HTTP method GET

.../v1/attachments/{checksum}/web.{format}

Supported HTTP method GET

.../v1/attachments/zip.{format}

Supported HTTP method POST

JSON request sample

.../v1/attachments/{checksumOrId}/aliases.{format}

Supported HTTP method GET

JSON response sample

.../v1/attachments/file/accesshistory/schema.{format}

Supported HTTP method GET

.../v1/attachments/file/{checksumOrId}/accesshistories.{format}

Supported HTTP method GET

JSON response sample

Authentication (login)

.../v1/login/schema.{format}

Supported HTTP method GET

.../v1/login.{format}

Supported HTTP method GET POST

JSON request sample Authentication method

.../v1/logout.{format}

Supported HTTP method GET

.../v1/configurations/{configName}.{format}

Supported HTTP method GET

.../v1/publicconfigurations/{configName}.{format}

Supported HTTP method GET

.../v1/contacts/schema.{format}

Supported HTTP method GET

.../v1/contacts.{format}

Supported HTTP method GET

JSON response sample

.../v1/delegations/signup.{format}

Supported HTTP method POST

JSON request sample

.../v1/delegations/signoff.{format}

Supported HTTP method POST

JSON request sample

.../v1/delegationstatuses.{format}

Supported HTTP method GET

JSON response sample

.../v1/delegationlogs/logins/{loginId}/mailboxes/{mailboxId}.{format}

Supported HTTP method GET

JSON response sample

Exported searches

.../v1/exportedsearches

Supported HTTP method GET

Exported file sample

.../v1/folders/schema.{format}

Supported HTTP method GET

.../v1/folders.{format}

Supported HTTP method GET POST

JSON request sample

JSON request sample

.../v1/folders/{folderId}.{format}

Supported HTTP method GET

JSON response sample

JSON request sample

.../v1/folders/{folderId}/messages.{format}

Supported HTTP method GET

JSON response sample

JSON request sample

.../v1/folders/{folderId}/messages/count.{format}

Supported HTTP method GET

.../v1/folders/{folderId}/messages/{messageId}.{format}

Supported HTTP method POST DELETE

.../v1/folders/{parentFolderId}/subfolders.{format}

Supported HTTP method GET

JSON response sample

JSON request sample

.../v1/folders/{parentFolderId}/subfolders/count.{format}

Supported HTTP method GET

.../v1/folders/{parentFolderId}/subfolders/{subfolderId}.{format}

Supported HTTP method POST DELETE

.../v1/groups/schema.{format}

Supported HTTP method GET

.../v1/groups.{format}

Supported HTTP method GET

.../v1/groups/count.{format}

Supported HTTP method GET

.../v1/groups/{groupId}.{format}

Supported HTTP method GET

.../v1/groups/{groupId}/logins.{format}

Supported HTTP method GET

.../v1/groups/{groupId}/logins/count.{format}

Supported HTTP method GET

.../v1/groups/{groupId}/logins/{loginId}.{format}

Supported HTTP method POST

.../v1/logins/schema.{format}

Supported HTTP method GET

.../v1/logins.{format}

Supported HTTP method GET POST PUT

.../v1/logins/me.{format}

Supported HTTP method GET

JSON response sample XML response sample

.../v1/logins/count.{format}

Supported HTTP method GET

.../v1/logins/{loginId}.{format}

Supported HTTP method GET PUT DELETE

.../v1/logins/{loginId}/mailboxes.{format}

Supported HTTP method GET

JSON response sample

JSON request sample JSON response sample

.../v1/logins/{loginId}/mailboxes/count.{format}

Supported HTTP method GET

.../v1/logins/{loginId}/mailboxes/{mailboxId}.{format}

Supported HTTP method POST DELETE

.../v1/logindomains/schema.{format}

Supported HTTP method GET

.../v1/logindomains.{format}

Supported HTTP method GET POST PUT

...v1/logindomains/count.{format}

Supported HTTP method GET

.../v1/logindomains/{logindomainId}.{format}

Supported HTTP method GET PUT

.../v1/logindomains/{logindomainId}/logins.{format}

Supported HTTP method GET POST

.../v1/logindomains/{logindomainId}/logins/count.{format}

Supported HTTP method GET

.../v1/logindomains/{logindomainId}/logins/{loginId}.{format}

Supported HTTP method POST DELETE

.../v1/mailboxes/schema.{format}

Supported HTTP method GET

.../v1/mailboxes.{format}

Supported HTTP method GET

JSON response sample

JSON request sample

JSON request sample

.../v1/mailboxes/count.{format}

Supported HTTP method GET

.../v1/mailboxes/{mailboxId}.{format}

Supported HTTP method GET

JSON response sample

JSON request sample

.../v1/mailboxes/{mailboxId}/folders.{format}

Supported HTTP method GET

JSON response sample

JSON request sample

.../v1/mailboxes/{mailboxId}/folders/count.{format}

Supported HTTP method GET

.../v1/mailboxes/{mailboxId}/logins.{format}

Supported HTTP method PUT

JSON request sample

.../v1/mailboxes/{mailboxId}/messages.{format}

Supported HTTP method GET

JSON response sample

JSON request sample

.../v1/mailboxes/{mailboxId}/messages/count.{format}

Supported HTTP method GET

.../v1/mailboxes/{mailboxId}/messages/{messageId}.{format}

Supported HTTP method POST DELETE

.../v1/mailstores/schema.{format}

Supported HTTP method GET

.../v1/mailstores.{format}

Supported HTTP method GET

.../v1/mailstores/count.{format}

Supported HTTP method GET

.../v1/mailstores/{mailstoreId}.{format}

Supported HTTP method GET

.../v1/mailstores/{mailstoreId}/mailboxes.{format}

Supported HTTP method GET

.../v1/mailstores/{mailstoreId}/mailboxes/count.{format}

Supported HTTP method GET

.../v1/messages/schema.{format}

Supported HTTP method GET

.../v1/messages.{format}

Supported HTTP method GET

JSON response sample

.../v1/messages/{messageId}.{format}

Supported HTTP method GET

.../v1/messages/{messageId}/html.{format}

Supported HTTP method GET

.../v1/messages/{messageId}/plaintext.{format}

Supported HTTP method GET

.../v1/messages/{messageId}/raw.{format}

Supported HTTP method GET

.../v1/messages/{messageId}/rtf.{format}

Supported HTTP method GET

.../v1/messages/{checksum}/bodyhtml

Supported HTTP method GET

.../v1/messages/{checksum}/eml

Supported HTTP method GET

.../v1/messages/{checksum}/sendmail.{format}

Supported HTTP method POST

JSON request sample

.../v1/messages/{checksum}/web.{format}

Supported HTTP method GET

JSON response sample with referencedAttachments property JSON response sample with SourceProperties property

.../v1/messages/searchresults/schema.{format}

Supported HTTP method GET

.../v1/messages/rtfImage/{fileName}

Supported HTTP method GET

.../v1/messages/web/schema.{format}

Supported HTTP method GET

.../v1/messages/web.{format}

Supported HTTP method GET

JSON response sample

.../v1/messages/{checksumOrId}/accesshistories.{format}

Supported HTTP method GET

JSON response sample

.../v1/messages/{checksumOrId}/availabletags.{format}

Supported HTTP method GET

.../v1/messages/{checksumOrId}/comments.{format}

Supported HTTP method GET

JSON response sample

.../v1/messages/{checksumOrId}/journalreports.{format}

Supported HTTP method GET

JSON response sample

.../v1/messages/{checksumOrId}/tags.{format}

Supported HTTP method GET

JSON response sample

.../v1/messages/{checksumOrId}/tags/{tagId}.{format}

Supported HTTP method GET POST DELETE

Message comments

.../v1/comments/schema.{format}

Supported HTTP method GET

.../v1/comments.{format}

Supported HTTP method GET POST PUT

.../v1/comments/{commentId}.{format}

Supported HTTP method GET PUT DELETE

Message folders

.../v1/messagefolders.{format}

Supported HTTP method PUT

JSON request sample 1 JSON request sample 2 JSON response sample

.../v1/messagetags.{format}

Supported HTTP method PUT

JSON request sample 1 JSON request sample 2 JSON response sample

.../v1/messagetypes.{format}

Supported HTTP method GET

Organizational units

.../v1/organizationalunits/schema.{format}

Supported HTTP method GET

.../v1/organizationalunits.{format}

Supported HTTP method GET

.../v1/organizationalunits/count.{format}

Supported HTTP method GET

.../v1/organizationalunits/{organizationalunitsId}.{format}

Supported HTTP method GET

.../v1/organizationalunits/{organizationalunitsId}/logins.{format}

Supported HTTP method GET

.../v1/organizationalunits/{organizationalunitsId}/logins/count.{format}

Supported HTTP method GET

.../v1/organizationalunits/{organizationalunitsId}/mailboxes.{format}

Supported HTTP method GET

.../v1/organizationalunits/{organizationalunitsId}/mailboxes/count.{format}

Supported HTTP method GET

.../v1/product/license.{format}

Supported HTTP method GET

.../v1/product/version.{format}

Supported HTTP method GET

.../v1/product/legalnotice/schema.{format}

Supported HTTP method GET

.../v1/product/legalnoticelist.{format}

Supported HTTP method GET

Retention change logs

.../v1/retentionchangelogs/schema.{format}

Supported HTTP method GET

.../v1/retentionchangelogs.{format}

Supported HTTP method GET

.../v1/retentionchangelogs/{retentionchangelogsId}.{format}

Supported HTTP method GET

Retention holds

.../v1/retentionholds/schema.{format}

Supported HTTP method GET

.../v1/retentionholds.{format}

Supported HTTP method GET POST

.../v1/retentionholds/{retentionholdId}.{format}

Supported HTTP method POST DELETE

Retention message logs

.../v1/retentionmessagelogs/schema.{format}

Supported HTTP method GET

.../v1/retentionmessagelogs.{format}

Supported HTTP method GET

.../v1/retentionmessagelogs/count.{format}

Supported HTTP method GET

.../v1/retentionmessagelogs/{retentionMessageLogId}.{format}

Supported HTTP method GET

.../v1/retentionmessagelogs/report/schema.{format}

Supported HTTP method GET

.../v1/retentionmessagelogs/report.{format}

Supported HTTP method GET

Retention policies

.../v1/retentionpolicies/schema.{format}

Supported HTTP method GET

.../v1/retentionpolicies.{format}

Supported HTTP method GET

.../v1/retentionpolicies/{retentionpolicyId}.{format}

Supported HTTP method GET

.../v1/retentionpolicies/retentionpolicyset.{format}

Supported HTTP method GET PUT

.../v1/retentionruns/schema.{format}

Supported HTTP method GET

.../v1/retentionruns.{format}

Supported HTTP method GET

.../v1/retentionruns/count.{format}

Supported HTTP method GET

.../v1/retentionruns/{retentionrunId}.{format}

Supported HTTP method GET

.../v1/retentionruns/{retentionrunId}/abort.{format}

Supported HTTP method GET

.../v1/retentionruns/{retentionrunId}/report.{format}

Supported HTTP method GET

.../v1/retentionruns/{retentionrunId}/review.{format}

Supported HTTP method GET

.../v1/retentionruns/{retentionrunId}/retentionrunpolicies.{format}

Supported HTTP method GET

.../v1/retentionruns/{retentionrunId}/retentionrunpolicies/count.{format}

Supported HTTP method GET

Retention run policies

.../v1/retentionrunpolicies/schema.{format}

Supported HTTP method GET

.../v1/retentionrunpolicies.{format}

Supported HTTP method GET

.../v1/retentionrunpolicies/count.{format}

Supported HTTP method GET

.../v1/retentionrunpolicies/{retentionrunpolicyId}.{format}

Supported HTTP method GET

Retention schedule

.../v1/retentionschedule/schema.{format}

Supported HTTP method GET

.../v1/retentionschedule.{format}

Supported HTTP method GET PUT

Retention settings

.../v1/retentionsettings/schema.{format}

Supported HTTP method GET

.../v1/retentionsettings.{format}

Supported HTTP method GET PUT

.../v1/securityroles/schema.{format}

Supported HTTP method GET

.../v1/securityroles.{format}

Supported HTTP method GET

.../v1/securityroles/{securityRoleId}.{format}

Supported HTTP method GET

.../v1/securityroles/{securityRoleId}/logins.{format}

Supported HTTP method GET

.../v1/server/authmode.{format}

Supported HTTP method GET

.../v1/server/timezone.{format}

Supported HTTP method GET

JSON response sample

.../v1/tags/schema.{format}

Supported HTTP method GET

.../v1/tags.{format}

Supported HTTP method GET POST PUT DELETE

.../v1/tags/count.{format}

Supported HTTP method GET

.../v1/tags/{tagId}.{format}

Supported HTTP method GET DELETE

.../v1/tags/{tagId}/messages.{format}

Supported HTTP method GET

.../v1/tags/{tagId}/messages/count.{format}

Supported HTTP method GET

GET

Retrieves JSON or XML schema for SearchResultPage<MessageSummary> object.

.../v1/messages/rtfImage/{fileName}

Supported HTTP method

Supported HTTP method

.../v1/messages/rtfImage/{fileName}

GET

Retrieves a specified Rich Text Format (RTF) image.

•

fileName: The RTF image name matching the pattern “<messagechecksum>.RTFBody.Image.<number>”.For example, 8963FFEC-F78C-42BA-A499-04E152D826B7.RTFBody.Image.1.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center