Google

Google Vault API

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault…

Productivity & workspace#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the required Vault privileges 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.

Endpoints 32

matters

  • POSTAdds an account as a matter collaborator./v1/matters/:matterId:addPermissionsAdds an account as a matter collaborator.
  • POSTCloses the specified matter/v1/matters/:matterId:closeCloses the specified matter. Returns the matter with updated state.
  • POSTCounts the accounts processed by the specified query./v1/matters/:matterId:countCounts the accounts processed by the specified query.
  • GETLists matters the requestor has access to./v1/matters?pageSize=0&pageToken=string&state=STATE_UNSPECIFIED&view=VIEW_UNSPECIFIEDLists matters the requestor has access to.
  • POSTCreates a matter with the given name and description/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…
  • GETGets the specified matter./v1/matters/:matterId?view=VIEW_UNSPECIFIEDGets the specified matter.
  • PUTUpdates the specified matter/v1/matters/:matterIdUpdates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored.…
  • DELETEDeletes the specified matter/v1/matters/:matterIdDeletes the specified matter. Returns the matter with updated state.
  • POSTRemoves an account as a matter collaborator./v1/matters/:matterId:removePermissionsRemoves an account as a matter collaborator.
  • POSTReopens the specified matter/v1/matters/:matterId:reopenReopens the specified matter. Returns the matter with updated state.
  • POSTUndeletes the specified matter/v1/matters/:matterId:undeleteUndeletes the specified matter. Returns the matter with updated state.

matters.exports

  • GETLists details about the exports in the specified matter./v1/matters/:matterId/exports?pageSize=0&pageToken=stringLists details about the exports in the specified matter.
  • POSTCreates an export./v1/matters/:matterId/exportsCreates an export.
  • GETGets an export./v1/matters/:matterId/exports/:exportIdGets an export.
  • DELETEDeletes an export./v1/matters/:matterId/exports/:exportIdDeletes an export.

matters.holds

  • POSTAdds accounts to a hold/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.
  • GETLists the holds in a matter./v1/matters/:matterId/holds?pageSize=0&pageToken=string&view=HOLD_VIEW_UNSPECIFIEDLists the holds in a matter.
  • POSTCreates a hold in the specified matter./v1/matters/:matterId/holdsCreates a hold in the specified matter.
  • GETGets the specified hold./v1/matters/:matterId/holds/:holdId?view=HOLD_VIEW_UNSPECIFIEDGets the specified hold.
  • PUTUpdates the scope (organizational unit or accounts) and query parameters of a hold/v1/matters/:matterId/holds/:holdIdUpdates 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…
  • DELETERemoves the specified hold and releases the accounts or organizational unit covered by the hold/v1/matters/:matterId/holds/:holdIdRemoves 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…
  • POSTRemoves the specified accounts from a hold/v1/matters/:matterId/holds/:holdId:removeHeldAccountsRemoves the specified accounts from a hold. Returns a list of statuses in the same order as the request.

matters.holds.accounts

  • GETLists the accounts covered by a hold/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…
  • POSTAdds an account to a hold/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…
  • DELETERemoves an account from a hold./v1/matters/:matterId/holds/:holdId/accounts/:accountIdRemoves an account from a hold.

matters.savedQueries

  • GETLists the saved queries in a matter./v1/matters/:matterId/savedQueries?pageSize=0&pageToken=stringLists the saved queries in a matter.
  • POSTCreates a saved query./v1/matters/:matterId/savedQueriesCreates a saved query.
  • GETRetrieves the specified saved query./v1/matters/:matterId/savedQueries/:savedQueryIdRetrieves the specified saved query.
  • DELETEDeletes the specified saved query./v1/matters/:matterId/savedQueries/:savedQueryIdDeletes the specified saved query.

operations

  • POSTStarts asynchronous cancellation on a long-running operation/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…
  • GETLists operations that match the specified filter in the request/v1/:name?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
  • DELETEDeletes a long-running operation/v1/:nameDeletes 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…

API details

Base URL
https://vault.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
32 operations on 20 pathsPOST 14GET 10DELETE 6PUT 2
Main resources
matters 11matters.holds 7matters.exports 4matters.savedQueries 4matters.holds.accounts 3operations 3
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Google Vault API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Google Vault API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Adds an account as a matter collaborator.” (POST /v1/matters/:matterId:addPermissions), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Google Vault API?

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault… It is listed under Productivity & workspace and has 32 endpoints.

Who publishes the Google Vault API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Google Vault API?

Requests go to https://vault.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Google Vault API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the Google Vault API have?

32 operations on 20 paths (14 POST, 10 GET, 6 DELETE, 2 PUT). The largest groups are matters, matters.holds, matters.exports, matters.savedQueries.

Is forking the Google Vault API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.