From 6c5ad42eaf3cdec54b76d79df14c191538798cc8 Mon Sep 17 00:00:00 2001 From: Pinkesh Date: Fri, 22 Nov 2024 14:16:01 +0530 Subject: [PATCH] Added Private APIs Cloud Function Configuration info --- .../backend-logic/api/rest-api.md | 30 ++++++++++++++----- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/resources/control-flow/backend-logic/api/rest-api.md b/docs/resources/control-flow/backend-logic/api/rest-api.md index 1862b03a..8a8fc3e8 100644 --- a/docs/resources/control-flow/backend-logic/api/rest-api.md +++ b/docs/resources/control-flow/backend-logic/api/rest-api.md @@ -615,14 +615,18 @@ To make the API call private, open the **Advanced Settings** tab, turn on the ** Optionally, you can force a user to be authenticated via the Firebase authentication to make this API call. To do so, turn on the **Require Authentication** toggle. + :::info -* If you make the API call private, **Firebase** should be connected to your project. Follow the - instructions on -[**this page**](../../../../ff-integrations/firebase/connect-to-firebase-setup.md) for integrating Firebase with FlutterFlow. -* If you enable the **Require Authentication** toggle, **Firebase Authentication** must be - configured appropriately. Check out -[this page](../../../../ff-integrations/authentication/firebase-auth/auth-initial-setup.md) for - setting up authentication. + +Private APIs are deployed as [**Cloud Functions**](https://firebase.google.com/docs/functions) within your Firebase project. While deploying, you can configure the following options: + +- **Use Custom Name for Cloud Function**: When enabled, allows you to specify a custom name for the deployed Cloud Function. By default, this option is disabled and Cloud Function is named as `ffPrivateApiCall`. +- **Private API Cloud Function Instances**: You can configure the number of Cloud Function instances to optimize performance and manage costs. + - **Min Instances**: Set the minimum number of active instances to reduce latency and avoid cold starts. Setting this value greater than 0 will keep instances warm but may incur additional costs. + - **Max Instances**: Define the maximum number of instances that can be scaled up based on demand. + + **Note**: To minimize costs, you can set the **Min Instances** value to 0. For detailed pricing information, refer to the [**Cloud Functions Pricing page**](https://cloud.google.com/functions/pricing-overview). + :::