Google

Firebase App Hosting API

Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub…

Developer tools#openapi

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

Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images.

Endpoints 14

projects.locations.operations

  • GETGets the latest state of a long-running operation/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • DELETEDeletes a long-running operation/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If…
  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.backends.traffic

  • PATCHUpdates a backend's traffic./v1/:name?requestId=string&updateMask=string&validateOnly=trueUpdates a backend's traffic.

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.backends

  • GETLists backends in a given project and location./v1/:parent/backends?filter=string&orderBy=string&pageSize=0&pageToken=string&showDeleted=trueLists backends in a given project and location.
  • POSTCreates a new backend in a given project and location./v1/:parent/backends?backendId=string&requestId=string&validateOnly=trueCreates a new backend in a given project and location.

projects.locations.backends.builds

  • GETLists builds in a given project, location, and backend./v1/:parent/builds?filter=string&orderBy=string&pageSize=0&pageToken=string&showDeleted=trueLists builds in a given project, location, and backend.
  • POSTCreates a new build for a backend./v1/:parent/builds?buildId=string&requestId=string&validateOnly=trueCreates a new build for a backend.

projects.locations.backends.domains

  • GETLists domains of a backend./v1/:parent/domains?filter=string&orderBy=string&pageSize=0&pageToken=string&showDeleted=trueLists domains of a backend.
  • POSTLinks a new domain to a backend./v1/:parent/domains?domainId=string&requestId=string&validateOnly=trueLinks a new domain to a backend.

projects.locations.backends.rollouts

  • GETLists rollouts for a backend./v1/:parent/rollouts?filter=string&orderBy=string&pageSize=0&pageToken=string&showDeleted=trueLists rollouts for a backend.
  • POSTCreates a new rollout for a backend./v1/:parent/rollouts?requestId=string&rolloutId=string&validateOnly=trueCreates a new rollout for a backend.

API details

Base URL
https://firebaseapphosting.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
14 operations on 8 pathsGET 7POST 5PATCH 1DELETE 1
Main resources
projects.locations.operations 4projects.locations.backends 2projects.locations.backends.builds 2projects.locations.backends.domains 2projects.locations.backends.rollouts 2projects.locations 1projects.locations.backends.traffic 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Firebase App Hosting API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Firebase App Hosting API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Firebase App Hosting API?

Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub… It is listed under Developer tools and has 14 endpoints.

Who publishes the Firebase App Hosting 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 App Hosting API?

Requests go to https://firebaseapphosting.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Firebase App Hosting API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Firebase App Hosting API have?

14 operations on 8 paths (7 GET, 5 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.operations, projects.locations.backends, projects.locations.backends.builds, projects.locations.backends.domains.

Is forking the Firebase App Hosting API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.