Method: deployments.list

Full name: projects.locations.instances.rules.deployments.list

Lists RuleDeployments across all Rules.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{parent}/deployments

Path parameters

Parameters
parent

string

Required. The collection of all parents which own all rule deployments. The "-" wildcard token must be used as the rule identifier in the resource path. Format: projects/{project}/locations/{location}/instances/{instance}/rules/-

Query parameters

Parameters
pageSize

integer

The maximum number of rule deployments to return. The service may return fewer than this value. If unspecified, at most 100 rule deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

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

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

string

A filter that can be used to retrieve specific rule deployments. The following fields are filterable: archived, name

Request body

The request body must be empty.

Response body

Response message for ListRuleDeployments.

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

JSON representation 
{
  "rule_deployments": [
    {
      object (RuleDeployment)
    }
  ],
  "next_page_token": string
}
Fields
rule_deployments[]

object (RuleDeployment)

The rule deployments from all rules.
next_page_token

string

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

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 parent resource:

  • chronicle.ruleDeployments.list

For more information, see the IAM documentation.