Method: integrationInstances.list

Full name: projects.locations.instances.integrations.integrationInstances.list

Lists all IntegrationInstances for a specific integration. Use this method to browse the configured integration instances available for custom or third-party product across different environments.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/integrationInstances

Path parameters

Parameters
parent

string

Required. The instance to list IntegrationInstances for. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/integrationInstances

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of IntegrationInstances to return. The service may return fewer than this value.
pageToken

string

Optional. A page token, received from a previous integrationInstances.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. The filter expression.
orderBy

string

Optional. The order in which IntegrationInstances should be returned.

Request body

The request body must be empty.

Response body

Response message for integrationInstances.list.

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

JSON representation 
{
  "integrationInstances": [
    {
      object (IntegrationInstance)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
integrationInstances[]

object (IntegrationInstance)

The list of IntegrationInstances.
nextPageToken

string

Optional. A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

The total number of IntegrationInstances.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.integrationInstances.get

For more information, see the IAM documentation.