Method: projects.rulesets.list
Stay organized with collections
Save and categorize content based on your preferences.
List Ruleset metadata only and optionally filter the results by Ruleset name.
The full Source contents of a Ruleset may be retrieved with rulesets.get.
HTTP request
GET https://firebaserules.googleapis.com/v1/{name=projects/*}/rulesets
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name for the project. Format: projects/{project_id}
|
Query parameters
| Parameters |
filter |
string
Ruleset filter. The list method supports filters with restrictions on Ruleset.name.
Filters on Ruleset.create_time should use the date function which parses strings that conform to the RFC 3339 date/time specifications. Example: createTime > date("2017-01-01T00:00:00Z") AND name=UUID-*
|
pageSize |
integer
Page size to load. Maximum of 100. Defaults to 10. Note: pageSize is just a hint and the service may choose to load less than pageSize due to the size of the output. To traverse all of the releases, caller should iterate until the pageToken is empty.
|
pageToken |
string
Next page token for loading the next batch of Ruleset instances.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"rulesets": [
{
object (Ruleset)
}
],
"nextPageToken": string
} |
| Fields |
rulesets[] |
object (Ruleset)
List of Ruleset instances.
|
nextPageToken |
string
The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
|
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/firebasehttps://www.googleapis.com/auth/firebase.readonly
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-06-30 UTC.
[null,null,["Last updated 2021-06-30 UTC."],[],[],null,["# Method: projects.rulesets.list\n\n- [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.ListRulesetsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList `Ruleset` metadata only and optionally filter the results by `Ruleset` name.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with [rulesets.get](/docs/reference/rules/rest/v1/projects.rulesets/get#google.firebase.rules.v1.FirebaseRulesService.GetRuleset).\n\n### HTTP request\n\n`GET https://firebaserules.googleapis.com/v1/{name=projects/*}/rulesets`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name for the project. Format: `projects/{project_id}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `createTime \u003e date(\"2017-01-01T00:00:00Z\") AND name=UUID-*` |\n| `pageSize` | `integer` Page size to load. Maximum of 100. Defaults to 10. Note: `pageSize` is just a hint and the service may choose to load less than `pageSize` due to the size of the output. To traverse all of the releases, caller should iterate until the `pageToken` is empty. |\n| `pageToken` | `string` Next page token for loading the next batch of `Ruleset` instances. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nThe response for [FirebaseRulesService.ListRulesets](/docs/reference/rules/rest/v1/projects.rulesets/list#google.firebase.rules.v1.FirebaseRulesService.ListRulesets).\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"rulesets\": [ { object (/docs/reference/rules/rest/v1/projects.rulesets#Ruleset) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------|\n| `rulesets[]` | `object (`[Ruleset](/docs/reference/rules/rest/v1/projects.rulesets#Ruleset)`)` List of `Ruleset` instances. |\n| `nextPageToken` | `string` The pagination token to retrieve the next page of results. If the value is empty, no further results remain. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `https://www.googleapis.com/auth/firebase`\n- `https://www.googleapis.com/auth/firebase.readonly`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
