Skip to content
OpenParablePublic APIs

Google Vault API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them.

Google Vault API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 32 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://vault.googleapis.com/
Version
v1
Endpoints
32
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://vault.googleapis.com/v1/matters" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://vault.googleapis.com/v1/matters", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://vault.googleapis.com/v1/matters",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1/mattersLists matters the requestor has access to.
POST/v1/mattersCreates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default vie
GET/v1/matters/{matterId}Gets the specified matter.
PUT/v1/matters/{matterId}Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Return
DELETE/v1/matters/{matterId}Deletes the specified matter. Returns the matter with updated state.
GET/v1/matters/{matterId}/exportsLists details about the exports in the specified matter.
POST/v1/matters/{matterId}/exportsCreates an export.
GET/v1/matters/{matterId}/exports/{exportId}Gets an export.
DELETE/v1/matters/{matterId}/exports/{exportId}Deletes an export.
GET/v1/matters/{matterId}/holdsLists the holds in a matter.
POST/v1/matters/{matterId}/holdsCreates a hold in the specified matter.
GET/v1/matters/{matterId}/holds/{holdId}Gets the specified hold.
PUT/v1/matters/{matterId}/holds/{holdId}Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor ca
DELETE/v1/matters/{matterId}/holds/{holdId}Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule,
GET/v1/matters/{matterId}/holds/{holdId}/accountsLists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the
POST/v1/matters/{matterId}/holds/{holdId}/accountsAdds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational
DELETE/v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}Removes an account from a hold.
POST/v1/matters/{matterId}/holds/{holdId}:addHeldAccountsAdds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
POST/v1/matters/{matterId}/holds/{holdId}:removeHeldAccountsRemoves the specified accounts from a hold. Returns a list of statuses in the same order as the request.
GET/v1/matters/{matterId}/savedQueriesLists the saved queries in a matter.
POST/v1/matters/{matterId}/savedQueriesCreates a saved query.
GET/v1/matters/{matterId}/savedQueries/{savedQueryId}Retrieves the specified saved query.
DELETE/v1/matters/{matterId}/savedQueries/{savedQueryId}Deletes the specified saved query.
POST/v1/matters/{matterId}:addPermissionsAdds an account as a matter collaborator.
POST/v1/matters/{matterId}:closeCloses the specified matter. Returns the matter with updated state.
POST/v1/matters/{matterId}:countCounts the accounts processed by the specified query.
POST/v1/matters/{matterId}:removePermissionsRemoves an account as a matter collaborator.
POST/v1/matters/{matterId}:reopenReopens the specified matter. Returns the matter with updated state.
POST/v1/matters/{matterId}:undeleteUndeletes the specified matter. Returns the matter with updated state.
GET/v1/{name}Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
DELETE/v1/{name}Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If th
POST/v1/{name}:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the serv

Questions

Does the Google Vault API API need an API key?

Yes. The Google Vault API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Google Vault API API support HTTPS?

Yes, the Google Vault API API is served over HTTPS.

How many endpoints does the Google Vault API API have?

Its OpenAPI description lists 32 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Google Vault API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).