You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/control-flow/backend-logic/api/rest-api.md
+22-8Lines changed: 22 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -615,14 +615,18 @@ To make the API call private, open the **Advanced Settings** tab, turn on the **
615
615
616
616
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.
617
617
618
+
618
619
:::info
619
-
* If you make the API call private, **Firebase** should be connected to your project. Follow the
620
-
instructions on
621
-
[**this page**](../../../../ff-integrations/firebase/connect-to-firebase-setup.md) for integrating Firebase with FlutterFlow.
622
-
* If you enable the **Require Authentication** toggle, **Firebase Authentication** must be
623
-
configured appropriately. Check out
624
-
[this page](../../../../ff-integrations/authentication/firebase-auth/auth-initial-setup.md) for
625
-
setting up authentication.
620
+
621
+
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:
622
+
623
+
-**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`.
624
+
-**Private API Cloud Function Instances**: You can configure the number of Cloud Function instances to optimize performance and manage costs.
625
+
-**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.
626
+
-**Max Instances**: Define the maximum number of instances that can be scaled up based on demand.
627
+
628
+
**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).
629
+
626
630
:::
627
631
628
632
<div style={{
@@ -632,7 +636,7 @@ Optionally, you can force a user to be authenticated via the Firebase authentica
@@ -651,6 +655,16 @@ Optionally, you can force a user to be authenticated via the Firebase authentica
651
655
</iframe>
652
656
</div>
653
657
658
+
:::note
659
+
* If you make the API call private, **Firebase** should be connected to your project. Follow the
660
+
instructions on
661
+
[**this page**](../../../../ff-integrations/firebase/connect-to-firebase-setup.md) for integrating Firebase with FlutterFlow.
662
+
* If you enable the **Require Authentication** toggle, **Firebase Authentication** must be
663
+
configured appropriately. Check out
664
+
[**this page**](../../../../ff-integrations/authentication/firebase-auth/auth-initial-setup.md) for
665
+
setting up authentication.
666
+
:::
667
+
654
668
### Process Streaming Response
655
669
656
670
When working with APIs that send data continuously, like Server Sent Events (SSE), you can enable this option. This ensures your app can handle the ongoing flow of data over a long-lasting HTTP connection to display real-time updates.
0 commit comments