Full name: projects.locations.instances.curatedRules.list
Lists CuratedRules.
HTTP request
Path parameters
Parameters
parent
string
Required. The parent, which owns this collection of curated rules. Format: projects/{project}/locations/{location}/instances/{instance}
Query parameters
Parameters
pageSize
integer
The maximum number of curated rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be corrected to 100.
pageToken
string
A page token, received from a previous curatedRules.list call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to curatedRules.list must match the call that provided the page token.
Request body
The request body must be empty.
Response body
Response message for curatedRules.list method.
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-31 UTC."],[[["\u003cp\u003eThis endpoint \u003ccode\u003eprojects.locations.instances.curatedRules.list\u003c/code\u003e retrieves a list of Curated Rules from a specified instance.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required, specifying the project, location, and instance from which to list the curated rules.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters are used for pagination, allowing retrieval of a large number of rules across multiple requests.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, with all necessary information provided through the path and query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes a list of \u003ccode\u003ecurated_rules\u003c/code\u003e and a \u003ccode\u003enext_page_token\u003c/code\u003e for subsequent pages, if any.\u003c/p\u003e\n"]]],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCuratedRulesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\n**Full name**: projects.locations.instances.curatedRules.list\n\nLists CuratedRules.\n\nHTTP request\n\nChoose a location: \nafrica-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu \n\n\u003cbr /\u003e\n\nPath parameters\n\n| Parameters ||\n|----------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent, which owns this collection of curated rules. Format: projects/{project}/locations/{location}/instances/{instance} |\n\nQuery parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of curated rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be corrected to 100. |\n| `pageToken` | `string` A page token, received from a previous `curatedRules.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `curatedRules.list` must match the call that provided the page token. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body Response message for curatedRules.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"curatedRules\": [ { object (/chronicle/docs/reference/rest/v1alpha/projects.locations.instances.curatedRules#CuratedRule) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `curatedRules[]` | `object (`[CuratedRule](/chronicle/docs/reference/rest/v1alpha/projects.locations.instances.curatedRules#CuratedRule)`)` The curated rules from the specified instance. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\nIAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `chronicle.curatedRules.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
