The Cloudant connector is a Palantir-provided driver for Cloudant.
To create a new Cloudant source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Cloudant-specific configuration and networking. For the complete property reference, see the official Cloudant driver documentation ↗.
The Cloudant connector is in the beta phase of development and may not be available on your enrollment. Functionality may change during active development.
| Capability | Status |
|---|---|
| Exploration | 🟡 Beta |
| Batch syncs | 🟡 Beta |
| Incremental | 🟡 Beta |
| OAuth 2.0 authentication | 🟡 Beta |
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
AuthScheme ↗ | Mandatory | The type of authentication to use when connecting to Cloudant. | OAuth |
URL ↗ | Mandatory | The URL used to connect to Cloudant. | https://{instance id}-bluemix.cloudantnosqldb.appdomain.cloud |
InitiateOAuth ↗ | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
The table below lists the domains that the source must be able to access to run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead. The agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| <URL> | If AuthScheme=OAuth OR using local instance (local instance in the format <Server>:<Port>) |
| <User>.cloudant.com | If AuthScheme=Basic |
This connector supports OAuth 2.0 authentication. Follow the OAuth 2.0 guidance for Palantir-provided drivers to configure and authorize the connection.