# Cloudant

<!-- BEGIN GENERATED:intro -->

The Cloudant connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for Cloudant.

To create a new Cloudant source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for Cloudant-specific configuration and networking. For the complete property reference, see the [official Cloudant driver documentation ↗](https://cdn.cdata.com/help/EWK/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

:::callout{theme="neutral" title="Beta"}
The Cloudant connector is in the [beta](../../platform-overview/development-life-cycle/index.md) phase of development and may not be available on your enrollment. Functionality may change during active development.
:::

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟡 Beta |
| Batch syncs | 🟡 Beta |
| Incremental | 🟡 Beta |
| [OAuth 2.0 authentication](#oauth-20-authentication) | 🟡 Beta |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`AuthScheme` ↗](https://cdn.cdata.com/help/EWK/jdbc/RSBCloudant_p_AuthScheme.htm) | Mandatory | The type of authentication to use when connecting to Cloudant. | `OAuth` |
| [`URL` ↗](https://cdn.cdata.com/help/EWK/jdbc/RSBCloudant_p_URL.htm) | Mandatory | The URL used to connect to Cloudant. | `https://{instance id}-bluemix.cloudantnosqldb.appdomain.cloud` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/EWK/jdbc/RSBCloudant_p_InitiateOAuth.htm) | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | `REFRESH` |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) 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` |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:oauth -->

## OAuth 2.0 authentication

This connector supports OAuth 2.0 authentication. Follow the [OAuth 2.0 guidance for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#oauth-20-authentication) to configure and authorize the connection.

<!-- END GENERATED:oauth -->