Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Create App Endpoints

  • Capella Operational
      +
      Create an App Endpoint to synchronize data between Couchbase Capella and mobile or IoT applications.

      Prerequisites

      Before creating an App Endpoint, verify that you have:

      • Created an App Service.

      • A Memory and Disk bucket available in the operational cluster linked to your App Service.

      • Verified that your bucket has maxTTL set to 0 (no bucket-level Time To Live configured).

      • Verified that collections you plan to link have maxTTL set to 0 (no collection-level Time To Live configured).

      App Services does not support Time To Live (TTL) on buckets or collections linked to App Endpoints. Collection-level TTL can cause App Services' system documents (including those with _sync prefixes) to expire, which prevents synchronization from functioning correctly. If you need expiry behavior, set expiration on individual documents or use per-collection sync functions.

      Create an App Endpoint

      1. In the navigation breadcrumbs in the Capella UI, do 1 of the following:

        1. Click your organization name or expand and select the organization where you want to work with App Services.

        2. Click your current project name or search for the project where you want to work with App Services.

      2. Go to App Services.

      3. Select your App Service from the list.

      4. Go to App Endpoint.

      5. Click Create App Endpoint.

      6. In the Create App Endpoint dialog, enter a name for your App Endpoint.

      7. Select a Memory and Disk bucket and a scope.

        The bucket must have maxTTL set to 0. See more about TTL restrictions.

      8. Select 1 or more collections to link to your App Endpoint.

        Collections must have maxTTL set to 0. You can link a maximum of 250 collections from a scope to an App Endpoint in a single linking operation.App Endpoints can share scopes but cannot link to the same collections.
        Linking large numbers of collections can result in long linking times. During linking, you cannot connect to your App Endpoint and sync data.

      9. Click Create App Endpoint.

      Your App Endpoint enters an Initializing state while App Services links the collections. Once linking completes, the App Endpoint moves to an Offline state.

      The default authentication provider is Basic Authentication. You can configure a different authentication provider after creation.

      Next Steps

      After creating your App Endpoint:

      1. Configure an authentication provider as the default is basic authentication.

      2. Set up access control and data validation per collection.

      3. Create app users and app roles.

      4. Configure advanced settings such as Delta Sync or Import Filters.

      5. Resume your App Endpoint to an Online state to allow client connections.

      For more information about App Endpoints, see About App Endpoints.