Method: projects.rulesets.list

ListRuleset metadata only and optionally filter the results byRuleset name.

The fullSource contents of aRuleset may be retrieved withrulesets.get.

HTTP request

GET https://firebaserules.googleapis.com/v1/{name=projects/*}/rulesets

The URL usesgRPC 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 onRuleset.name.

Filters onRuleset.create_time should use thedate 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 thanpageSize due to the size of the output. To traverse all of the releases, caller should iterate until thepageToken is empty.

pageToken

string

Next page token for loading the next batch ofRuleset instances.

Request body

The request body must be empty.

Response body

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

The response forFirebaseRulesService.ListRulesets.

JSON representation
{"rulesets":[{object (Ruleset)}],"nextPageToken":string}
Fields
rulesets[]

object (Ruleset)

List ofRuleset 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-platform
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2021-06-30 UTC.