firebaserules.projects.rulesets.list

GET {{baseUrl}}/v1/:name/rulesets?filter=<string>&pageSize=<integer>&pageToken=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

List Ruleset metadata only and optionally filter the results by Ruleset name. The full Source contents of a Ruleset may be retrieved with GetRuleset.

Request Params

KeyDatatypeRequiredDescription
filterstringRuleset 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: create_time &gt; date(&quot;2017-01-01T00:00:00Z&quot;) AND name=UUID-*
pageSizestringPage size to load. Maximum of 100. Defaults to 10. Note: page_size is just a hint and the service may choose to load less than page_size due to the size of the output. To traverse all of the releases, caller should iterate until the page_token is empty.
pageTokenstringNext page token for loading the next batch of Ruleset instances.
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

RESPONSES

status: OK

{&quot;nextPageToken&quot;:&quot;aute nulla irure&quot;,&quot;rulesets&quot;:[{&quot;createTime&quot;:&quot;consequat minim veniam&quot;,&quot;metadata&quot;:{&quot;services&quot;:[&quot;magna ea culpa elit amet&quot;,&quot;mollit proident cillum elit fugiat&quot;]},&quot;name&quot;:&quot;reprehenderit amet id in&quot;,&quot;source&quot;:{&quot;files&quot;:[{&quot;content&quot;:&quot;nisi ut id&quot;,&quot;fingerprint&quot;:&quot;reprehe&quot;,&quot;name&quot;:&quot;in anim&quot;},{&quot;content&quot;:&quot;Duis amet Excepteur&quot;,&quot;fingerprint&quot;:&quot;elit fugiat qui&quot;,&quot;name&quot;:&quot;elit sint ullamco&quot;}]}},{&quot;createTime&quot;:&quot;reprehenderit ut tempor minim&quot;,&quot;metadata&quot;:{&quot;services&quot;:[&quot;laborum irure adipisicing&quot;,&quot;in amet irure pariatur&quot;]},&quot;name&quot;:&quot;amet&quot;,&quot;source&quot;:{&quot;files&quot;:[{&quot;content&quot;:&quot;est sunt dolore&quot;,&quot;fingerprint&quot;:&quot;consequat labore veniam&quot;,&quot;name&quot;:&quot;incididunt nisi non ullamco&quot;},{&quot;content&quot;:&quot;tempor cupidatat Lorem aliquip&quot;,&quot;fingerprint&quot;:&quot;dolor dolore&quot;,&quot;name&quot;:&quot;sint enim sed do sunt&quot;}]}}]}