0% found this document useful (0 votes)
65 views

Google Vault API - Google Developers-1 PDF

The document discusses Google Vault API and resources for retention and eDiscovery. It provides information on required privileges to access vault, services endpoints, discovery documents, and REST resources and methods. Mr. SANTHOSH of Google Developer Group is referenced as a contact for Vault API help.

Uploaded by

SANTHOSH B
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
65 views

Google Vault API - Google Developers-1 PDF

The document discusses Google Vault API and resources for retention and eDiscovery. It provides information on required privileges to access vault, services endpoints, discovery documents, and REST resources and methods. Mr. SANTHOSH of Google Developer Group is referenced as a contact for Vault API help.

Uploaded by

SANTHOSH B
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

Google Developer Group’s

Mr.SANTHOSH Reference for Vault API


Retention and eDiscovery for Google Workspace and Google Developers

To work together with Vault Resources Help of Google, the account must have the required Vault
privileges
(https://support.google.com/vault/answer/2799699) and access and get permission to Mr.SANTHOSH the
Google Developer 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.

Service’s: vault.googleapis.com
To call this service, we recommend that you use the Google and Google Developer Mr.SANTHOSH is
possible to produce our vault services

(https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own


libraries to call this service, use the following information when you make the API requests.
Documentation reference:
A Discovery Document (https://developers.google.com/discovery/v1/reference/apis) is a machinereadable
specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins,
and other tools that interact with Google APIs. One service may provide multiple discovery
documents. This service provides the following discovery document:

https://vault.googleapis.com/$discovery/rest?version=v1
(https://vault.googleapis.com/$discovery/rest?version=v1)

Service endpoint
A service endpoint (https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that
specifies the network address of an API service. One service might have multiple service endpoints.
This service has the following service endpoint and all URIs below are relative to this service endpoint:

https://vault.googleapis.com
REST Resource: v1.ma ers (/vault/reference/rest/v1/matters)

Methods

addPermissions POST /v1/matters/{matterId}:addPermissions


(/vault/reference/rest/v1 Adds an account as a matter collaborator.
/matters/addPermissions
)

close POST /v1/matters/{matterId}:close


(/vault/reference/rest/v1 Closes the specified matter.
/matters/close)

count POST /v1/matters/{matterId}:count


(/vault/reference/rest/v1 Counts the accounts processed by the specified query.
/matters/count)

create POST /v1/matters


(/vault/reference/rest/v1 Creates a matter with the given name and description.
/matters/create)
Methods

(/vault/reference/rest/v1
delete DELETE /v1/matters/{matterId}
(/vault/reference/rest/v1 Deletes the specified matter.
/matters/delete)

get GET /v1/matters/{matterId}


(/vault/reference/rest/v1 Gets the specified matter.
/matters/get)

list GET /v1/matters


(/vault/reference/rest/v1 Lists matters the requestor has access to.
/matters/list)

removePermissions POST /v1/matters/{matterId}:removePermissions


(/vault/reference/rest/v1 Removes an account as a matter collaborator.
/matters/removePermissi ons)

reopen POST /v1/matters/{matterId}:reopen


(/vault/reference/rest/v1 Reopens the specified matter.
/matters/reopen)

undelete POST /v1/matters/{matterId}:undelete


(/vault/reference/rest/v1 Undeletes the specified matter. /matters/undelete)
update PUT /v1/matters/{matterId} Updates the specified matter.
/matters/update)

REST Resource: v1.ma ers.expo s (/vault/reference/rest/v1/matters.exports)


Methods

create POST /v1/matters/{matterId}/exports


(/vault/reference/rest/v1 Creates an export.
/matters.exports/create)

delete DELETE /v1/matters/{matterId}/exports/{exportId}


(/vault/reference/rest/v1 Deletes an export.
/matters.exports/delete)

get GET /v1/matters/{matterId}/exports/{exportId}


(/vault/reference/rest/v1 Gets an export.
/matters.exports/get)

list GET /v1/matters/{matterId}/exports


(/vault/reference/rest/v1 Lists details about the exports in the specified matter. /matters.exports/list)

REST Resource: v1.ma ers.holds (/vault/reference/rest/v1/matters.holds)

Methods

addHeldAccounts POST /v1/matters/{matterId}/holds/{holdId}:addHeldAccounts


(/vault/reference/rest/v1 Adds accounts to a hold.
/matters.holds/addHeldA ccounts)

create POST /v1/matters/{matterId}/holds


(/vault/reference/rest/v1 Creates a hold in the specified matter.
/matters.holds/create)
Methods

(/vault/reference/rest/v1
delete DELETE /v1/matters/{matterId}/holds/{holdId}
Removes the specified hold and releases the accounts or organizational unit /matters.holds/delete) covered by the
hold.

get GET /v1/matters/{matterId}/holds/{holdId}


(/vault/reference/rest/v1 Gets the specified hold.
/matters.holds/get)

list GET /v1/matters/{matterId}/holds


(/vault/reference/rest/v1 Lists the holds in a matter.
/matters.holds/list)

removeHeldAccounts POST /v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts


(/vault/reference/rest/v1 Removes the specified accounts from a hold.
/matters.holds/removeHe ldAccounts)

update PUT /v1/matters/{matterId}/holds/{holdId}


(/vault/reference/rest/v1 Updates the scope (organizational unit or accounts) and query parameters of a
/matters.holds/update) hold.

REST Resource: v1.ma ers.holds.accounts


(/vault/reference/rest/v1/matters.holds.accounts)

Methods

create POST /v1/matters/{matterId}/holds/{holdId}/accounts


(/vault/reference/rest/v1 Adds an account to a hold.
/matters.holds.accounts/c reate)

delete DELETE /v1/matters/{matterId}/holds/{holdId}/accounts/


Methods

(/vault/reference/rest/v1 {accountId}
/matters.holds.accounts/ Removes an account from a hold.
delete)

list GET /v1/matters/{matterId}/holds/{holdId}/accounts Lists the accounts covered by a hold.


/matters.holds.accounts/li st)

REST Resource: v1.ma ers.savedQueries


(/vault/reference/rest/v1/matters.savedQueries)

Methods

create POST /v1/matters/{matterId}/savedQueries


(/vault/reference/rest/v1 Creates a saved query.
/matters.savedQueries/cr eate)

delete DELETE /v1/matters/{matterId}/savedQueries/{savedQueryId}


(/vault/reference/rest/v1 Deletes the specified saved query.
/matters.savedQueries/d elete)

get GET /v1/matters/{matterId}/savedQueries/{savedQueryId}


(/vault/reference/rest/v1 Retrieves the specified saved query.
/matters.savedQueries/g et)

list GET /v1/matters/{matterId}/savedQueries


(/vault/reference/rest/v1 Lists the saved queries in a matter. /matters.savedQueries/lis
t)

REST Resource: v1.operations (/vault/reference/rest/v1/operations)


Methods

(/vault/reference/rest/v1

Methods
cancel POST /v1/{name=operations/**}:cancel
(/vault/reference/rest/v1 Starts asynchronous cancellation on a long-running operation.
/operations/cancel)

delete DELETE /v1/{name=operations/**}


(/vault/reference/rest/v1 Deletes a long-running operation.
/operations/delete)

get GET /v1/{name=operations/**}


(/vault/reference/rest/v1 Gets the latest state of a long-running operation.
/operations/get)

list GET /v1/{name}


(/vault/reference/rest/v1 Lists operations that match the specified filter in the request.
/operations/list)

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
(https://creativecommons.org/licenses/by/4.0/), and code samples are licensed under the Apache 2.0 License
(https://www.apache.org/licenses/LICENSE-2.0). For details, see the Google Developers Site Policies
(https://developers.google.com/site-policies). Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-02-24 UTC.

Responsible -Google Developer Group’s


Mr.SANTHOSH
Google Developer (GDG)
Google Community Team.
Gmail : [email protected]

You might also like