Full name: projects.locations.instances.rules.deployments.list
Lists RuleDeployments across all Rules.
HTTP request
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 deployments.list call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to deployments.list 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 deployments.list.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis webpage details the \u003ccode\u003eprojects.locations.instances.rules.deployments.list\u003c/code\u003e method for retrieving RuleDeployments across all Rules within a specified parent path.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003eGET\u003c/code\u003e method at the endpoint \u003ccode\u003ehttps://chronicle.googleapis.com/v1alpha/{parent}/deployments\u003c/code\u003e, where \u003ccode\u003eparent\u003c/code\u003e is a required path parameter specifying the collection of rule deployment owners.\u003c/p\u003e\n"],["\u003cp\u003eQuery parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e are available to refine the list results, allowing control over the number of rule deployments returned, pagination, and specific filtering.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this method must be empty, while the successful response body contains a JSON representation that lists \u003ccode\u003erule_deployments\u003c/code\u003e and \u003ccode\u003enext_page_token\u003c/code\u003e for potential pagination.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this method requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003echronicle.ruleDeployments.list\u003c/code\u003e on the parent resource.\u003c/p\u003e\n"]]],[],null,[]]