Firebase Realtime Database Management API
The Firebase Realtime Database API enables programmatic provisioning and management of Realtime Database instances.
Data & analytics#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
The Firebase Realtime Database API enables programmatic provisioning and management of Realtime Database instances.
Endpoints 7
projects.locations.instances
- GETLists each DatabaseInstance associated with the specified parent project
/v1beta/:parent/instances?pageSize=0&pageToken=string&showDeleted=trueLists each DatabaseInstance associated with the specified parent project. The list items are returned in no particular order, but will be a consistent view of… - POSTRequests that a new DatabaseInstance be created
/v1beta/:parent/instances?databaseId=string&validateOnly=trueRequests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze… - GETGets the DatabaseInstance identified by the specified resource name.
/v1beta/:nameGets the DatabaseInstance identified by the specified resource name. - DELETEMarks a DatabaseInstance to be deleted
/v1beta/:nameMarks a DatabaseInstance to be deleted. The DatabaseInstance will be set to the DELETED state for 20 days, and will be purged within 30 days. The default… - POSTDisables a DatabaseInstance
/v1beta/:name:disableDisables a DatabaseInstance. The database can be re-enabled later using ReenableDatabaseInstance. When a database is disabled, all reads and writes are… - POSTEnables a DatabaseInstance
/v1beta/:name:reenableEnables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled… - POSTRestores a DatabaseInstance that was previously marked to be deleted
/v1beta/:name:undeleteRestores a DatabaseInstance that was previously marked to be deleted. After the delete method is used, DatabaseInstances are set to the DELETED state for 20…
API details
- Base URL
https://firebasedatabase.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 4 scopes
An API key in the key query parameter - Operations
- 7 operations on 5 pathsPOST 4GET 2DELETE 1
- Main resources
- projects.locations.instances 7
- Response formats
application/json- Description format
- Google API Discovery, API version
v1beta - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Firebase Realtime Database Management 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 Realtime Database Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists each DatabaseInstance associated with the specified parent project” (GET /v1beta/:parent/instances?pageSize=0&pageToken=string&showDeleted=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Firebase Realtime Database Management API?
The Firebase Realtime Database API enables programmatic provisioning and management of Realtime Database instances. It is listed under Data & analytics and has 7 endpoints.
Who publishes the Firebase Realtime Database Management 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 Realtime Database Management API?
Requests go to https://firebasedatabase.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Firebase Realtime Database Management API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 4 scopes; an API key in the key query parameter.
How many endpoints does the Firebase Realtime Database Management API have?
7 operations on 5 paths (4 POST, 2 GET, 1 DELETE). The largest groups are projects.locations.instances.
Is forking the Firebase Realtime Database Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.