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>"aUser=<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
Key | Datatype | Required | Description |
---|---|---|---|
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: create_time > date("2017-01-01T00:00:00Z") AND name=UUID-* | |
pageSize | string | Page 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. | |
pageToken | string | Next page token for loading the next batch of Ruleset instances. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API 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_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available 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_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"nextPageToken":"aute nulla irure","rulesets":[{"createTime":"consequat minim veniam","metadata":{"services":["magna ea culpa elit amet","mollit proident cillum elit fugiat"]},"name":"reprehenderit amet id in","source":{"files":[{"content":"nisi ut id","fingerprint":"reprehe","name":"in anim"},{"content":"Duis amet Excepteur","fingerprint":"elit fugiat qui","name":"elit sint ullamco"}]}},{"createTime":"reprehenderit ut tempor minim","metadata":{"services":["laborum irure adipisicing","in amet irure pariatur"]},"name":"amet","source":{"files":[{"content":"est sunt dolore","fingerprint":"consequat labore veniam","name":"incididunt nisi non ullamco"},{"content":"tempor cupidatat Lorem aliquip","fingerprint":"dolor dolore","name":"sint enim sed do sunt"}]}}]}