Help Center

Find help articles, support information and more.

Audit Vault for M365 API Reference


Introduction:

Our API's are a great way to help developers speed up workflows and reduce manual tasks when integrating with Audit Vault for M365.


What you'll learn:
  • How to generate a Secret Key that allows you to call the Audit Vault for M365 RESTFul API.
  • What endpoints are available to integrate with.
  • How to make requests to the Audit Vault for M365 API.
Prerequisites:

Before you begin, make sure the following is already set up:

  • Audit Vault for M365 has been successfully configured for your organization.

API Reference:

Before using the Audit Vault for M365 API, you need to generate a secret key. The key is required for making any call out our API's. Please see below for the end points that are currently available.

API Keys:

To create a secret key for the API, please do the following:

  1. Log into Audit Vault as a Company Administrator.
  2. Navigate to Company --> API Keys
  3. Under the "Create New Key" section, select an Expiry Date.
  4. Click on the "Create" button.

You new key will be listed below. Keep this secret for calling the API.
API Endpoints:

Below are the list of endpoints currently available:


Preserve Audit Logs by Site Collection:

This API allows you to add a SharePoint Site URL to the list of sites that will have their audit logs preserved, only if the tenant has enabled the “Preserve Audit Logs by Site Collection” feature.

Requests:

Method Url
Post https://<audit-vault-api-url>/api/AddSiteCollectionToAuditLogFilter

Request Parameters:

Field Type Description
apiSecretKey string Secret Key generated from Audit Vault for M365
siteCollectionUrl string Full Url of the site collection to be added to the site collection filter in Audit Vault for M365.

Response:

If successful, the API will return a 200 OK status and a boolean indicating if the site url was added or not.

Success Example:
{ true }

A boolean of false may be returned. This may occur under the following conditions:

  • Invalid Secret Key.
  • Site-specific audit log retention is disabled.
  • The Site Url is invalid or does not exist in your Tenant.

Notes:

  • This endpoint only works if site-specific audit log retention is enabled.
  • Consider automating this call as part of your internal site provisioning workflow.


Need Help? Reach out to support by clicking the button below.

Contact Us »