Firebase Management API

The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.

Workflow: Set up a Firebase project using the REST API

For programmatic setup of a FirebaseProject, you'll add Firebase resources and apps to an existing Google Cloud Platform (GCP) Project.

If you don't already have an existing GCP Project, you can create one using the GCP Resource Manager API. Visit Understand Firebase projects for details about the number of projects allowed per account.

To set up a Firebase project, call the REST endpoints in the following order:

  1. Find the resource name of the existing GCP Project to which you want to add Firebase resources by calling availableProjects.list.

    Use this unique identifier (for example, projects/my-project-123) in later calls.

  2. Add Firebase resources to the GCP Project by calling projects.addFirebase.

    1. For this call, specify all fields in the request body.
    2. To call projects.addFirebase, a member must be an Editor or Owner for the existing GCP Project.

  3. Add an app to your FirebaseProject:

    • Add an iOS app by calling projects.iosApps.create.

      For this call, specify name, displayName, and bundleId in the request body.

    • Add an Android app by calling projects.androidApps.create.

      For this call, specify name, displayName, and packageName in the request body.

For information about programmatic access management for these calls, visit the Cloud Identity Access Management (IAM) API documentation.

Service: firebase.googleapis.com

All URIs below are relative to https://firebase.googleapis.com

This service provides the following discovery documents:

REST Resource: v1beta1.availableProjects

Methods
list GET /v1beta1/availableProjects
Returns a list of Google Cloud Platform (GCP) Projects that are available to have Firebase resources added to them.

REST Resource: v1beta1.projects

Methods
addFirebase POST /v1beta1/{project=projects/*}:addFirebase
Adds Firebase resources to the specified existing Google Cloud Platform (GCP) Project.
get GET /v1beta1/{name=projects/*}
Gets the FirebaseProject identified by the specified resource name.
getAdminSdkConfig GET /v1beta1/{name=projects/*/adminSdkConfig}
Gets the configuration artifact used by servers to simplify initialization.
list GET /v1beta1/projects
Lists each FirebaseProject accessible to the caller.
patch PATCH /v1beta1/{project.name=projects/*}
Updates the attributes of the FirebaseProject identified by the specified resource name.
searchApps GET /v1beta1/{parent=projects/*}:searchApps
A convenience method that lists all available Apps for the specified FirebaseProject.

REST Resource: v1beta1.projects.androidApps

Methods
create POST /v1beta1/{parent=projects/*}/androidApps
Requests that a new AndroidApp be created.
get GET /v1beta1/{name=projects/*/androidApps/*}
Gets the AndroidApp identified by the specified resource name.
getConfig GET /v1beta1/{name=projects/*/androidApps/*/config}
Gets the configuration artifact associated with the specified AndroidApp.
list GET /v1beta1/{parent=projects/*}/androidApps
Lists each AndroidApp associated with the specified parent Project.
patch PATCH /v1beta1/{app.name=projects/*/androidApps/*}
Updates the attributes of the AndroidApp identified by the specified resource name.

REST Resource: v1beta1.projects.androidApps.sha

Methods
create POST /v1beta1/{parent=projects/*/androidApps/*}/sha
Adds a SHA certificate to the specified AndroidApp.
delete DELETE /v1beta1/{name=projects/*/androidApps/*/sha/*}
Removes a SHA certificate from the specified AndroidApp.
list GET /v1beta1/{parent=projects/*/androidApps/*}/sha
Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp.

REST Resource: v1beta1.projects.iosApps

Methods
create POST /v1beta1/{parent=projects/*}/iosApps
Requests that a new IosApp be created.
get GET /v1beta1/{name=projects/*/iosApps/*}
Gets the IosApp identified by the specified resource name.
getConfig GET /v1beta1/{name=projects/*/iosApps/*/config}
Gets the configuration artifact associated with the specified IosApp.
list GET /v1beta1/{parent=projects/*}/iosApps
Lists each IosApp associated with the specified parent Project.
patch PATCH /v1beta1/{app.name=projects/*/iosApps/*}
Updates the attributes of the IosApp identified by the specified resource name.

Service: firebase.googleapis.com

All URIs below are relative to https://firebase.googleapis.com

This service provides the following discovery documents:

REST Resource: v1.operations

Methods
cancel POST /v1/{name=operations/**}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=operations/**}
Deletes a long-running operation.
get GET /v1/{name=operations/**}
Gets the latest state of a long-running operation.
list GET /v1/{name}
Lists operations that match the specified filter in the request.

Send feedback about...

This page
Documentation feedback
Firebase
Firebase
Product feedback
Need help? Visit our support page.