Method: legacy.legacyBatchGetCollections

Full name: projects.locations.instances.legacy.legacyBatchGetCollections

RPC for getting a batch of collections based on their Collection Ids.

HTTP request


Path parameters

Parameters
instance

string

Required. Chronicle instance this request is sent to. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
collectionIds[]

string

Required. Collection IDs to retrieve. Returns a maximum of 10,000 Collections. Results over 10,000 will be truncated to 10,000. Collection IDs should be in the de_ or sa_ format.

Request body

The request body must be empty.

Response body

Response message for BatchGetCollections. This is a list of Collections.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "collections": [
    {
      object (Collection)
    }
  ]
}
Fields
collections[]

object (Collection)

List of Collections for a customer instance.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.legacies.legacyBatchGetCollections

For more information, see the IAM documentation.