Firebase Rules API
Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.
Endpoints 9
projects
- POSTTest `Source` for syntactic and semantic correctness
/v1/:name:testTest Source for syntactic and semantic correctness. Issues present, if any, will be returned to the caller with a description, severity, and source location.…
projects.releases
- GETList the `Release` values for a project
/v1/:name/releases?filter=string&pageSize=0&pageToken=stringList the Release values for a project. This list may optionally be filtered by Release name, Ruleset name, TestSuite name, or any combination thereof. - POSTCreate a `Release`
/v1/:name/releasesCreate a Release. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name,… - PATCHUpdate a `Release` via PATCH
/v1/:nameUpdate a Release via PATCH. Only updates to ruleset_name will be honored. Release rename is not supported. To create a Release use the CreateRelease method. - GETGet the `Release` executable to use when enforcing rules.
/v1/:name:getExecutable?executableVersion=RELEASE_EXECUTABLE_VERSION_UNSPECIFIEDGet the Release executable to use when enforcing rules.
projects.rulesets
- GETGet a `Ruleset` by name including the full `Source` contents.
/v1/:nameGet a Ruleset by name including the full Source contents. - DELETEDelete a `Ruleset` by resource name
/v1/:nameDelete a Ruleset by resource name. If the Ruleset is referenced by a Release the operation will fail. - GETList `Ruleset` metadata only and optionally filter the results by `Ruleset` name
/v1/:name/rulesets?filter=string&pageSize=0&pageToken=stringList Ruleset metadata only and optionally filter the results by Ruleset name. The full Source contents of a Ruleset may be retrieved with GetRuleset. - POSTCreate a `Ruleset` from `Source`
/v1/:name/rulesetsCreate a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors…
API details
- Base URL
https://firebaserules.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter - Operations
- 9 operations on 5 pathsGET 4POST 3PATCH 1DELETE 1
- Main resources
- projects.releases 4projects.rulesets 4projects 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Firebase Rules API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Firebase Rules API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Test `Source` for syntactic and semantic correctness” (POST /v1/:name:test), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Firebase Rules API?
Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request. It is listed under Developer tools and has 9 endpoints.
Who publishes the Firebase Rules API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Firebase Rules API?
Requests go to https://firebaserules.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Firebase Rules API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.
How many endpoints does the Firebase Rules API have?
9 operations on 5 paths (4 GET, 3 POST, 1 PATCH, 1 DELETE). The largest groups are projects.releases, projects.rulesets, projects.
Is forking the Firebase Rules API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.