Skip to content

Commit 6c5ad42

Browse files
committed
Added Private APIs Cloud Function Configuration info
1 parent c28eca7 commit 6c5ad42

File tree

1 file changed

+22
-8
lines changed
  • docs/resources/control-flow/backend-logic/api

1 file changed

+22
-8
lines changed

docs/resources/control-flow/backend-logic/api/rest-api.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -615,14 +615,18 @@ To make the API call private, open the **Advanced Settings** tab, turn on the **
615615

616616
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.
617617

618+
618619
:::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+
626630
:::
627631

628632
<div style={{
@@ -632,7 +636,7 @@ Optionally, you can force a user to be authenticated via the Firebase authentica
632636
width: '100%'
633637
}}>
634638
<iframe
635-
src="https://demo.arcade.software/xoPi2UVZuw3JMqyXPeau?embed&show_copy_link=true"
639+
src="https://demo.arcade.software/TLjzzkK3n9PQGBFDte4L?embed&show_copy_link=true"
636640
title=""
637641
style={{
638642
position: 'absolute',
@@ -651,6 +655,16 @@ Optionally, you can force a user to be authenticated via the Firebase authentica
651655
</iframe>
652656
</div>
653657

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+
654668
### Process Streaming Response
655669

656670
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

Comments
 (0)