# IBM Cloud Data Engine

<!-- BEGIN GENERATED:intro -->

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

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

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

:::callout{theme="neutral" title="Beta"}
The IBM Cloud Data Engine 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 |
|---|---|---|---|
| [`ApiKey` ↗](https://cdn.cdata.com/help/SIK/jdbc/RSBIBMCloudSQLQuery_p_ApiKey.htm) | Mandatory | The API Key used to identify the user to IBM Cloud. | — |
| [`CloudObjectStorageCRN` ↗](https://cdn.cdata.com/help/SIK/jdbc/RSBIBMCloudSQLQuery_p_CloudObjectStorageCRN.htm) | Recommended | The CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud. | — |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/SIK/jdbc/RSBIBMCloudSQLQuery_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` |
| [`SqlQueryCRN` ↗](https://cdn.cdata.com/help/SIK/jdbc/RSBIBMCloudSQLQuery_p_SqlQueryCRN.htm) | Recommended | The CRN which uniquely identifies your SQL Query instance in IBM Cloud. | — |

<!-- 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 |
|--- |--- |
| iam.bluemix.net | Always |
| api.dataengine.cloud.ibm.com | Always. New v3 endpoint, most likely required/used unless an older version of the driver |
| \<Region>.cloud-object-storage.appdomain.cloud | Always. Region connection property is mapped (may also be returned by IBM or part of CRN) |
| resource-controller.cloud.ibm.com | If CRN is not provided |
| sql-api.ng.bluemix.net | Old v2 endpoint replaced by api.dataengine.cloud.ibm.com |

### Region mappings

Use the following region mapping to complete the domain URL:

| Region  | Endpoint |
|--- |--- |
| us |  s3.us |
| us-standard |  s3.us |
| us-cold |  s3.us |
| us-flex |  s3.us |
| us-smart |  s3.us |
| us-vault |  s3.us |
| us-geo |  s3.us |
| us-geo-cold |  s3.us |
| us-geo-flex |  s3.us |
| us-geo-smart |  s3.us |
| us-geo-vault |  s3.us |
| us-geo-standard |  s3.us |
| us-dallas |  s3.dal.us |
| us-dallas-cold |  s3.dal.us |
| us-dallas-flex |  s3.dal.us |
| us-dallas-smart |  s3.dal.us |
| us-dallas-vault |  s3.dal.us |
| us-dallas-standard |  s3.dal.us |
| dal-us-geo |  s3.dal.us |
| dal-us-geo-cold |  s3.dal.us |
| dal-us-geo-flex |  s3.dal.us |
| dal-us-geo-smart |  s3.dal.us |
| dal-us-geo-vault |  s3.dal.us |
| dal-us-geo-standard |  s3.dal.us |
| us-sanjose |  s3.sjc.us |
| us-sanjose-cold |  s3.sjc.us |
| us-sanjose-flex |  s3.sjc.us |
| us-sanjose-smart |  s3.sjc.us |
| us-sanjose-vault |  s3.sjc.us |
| us-sanjose-standard |  s3.sjc.us |
| sjc-us-geo |  s3.sjc.us |
| sjc-us-geo-cold |  s3.sjc.us |
| sjc-us-geo-flex |  s3.sjc.us |
| sjc-us-geo-smart |  s3.sjc.us |
| sjc-us-geo-vault |  s3.sjc.us |
| sjc-us-geo-standard |  s3.sjc.us |
| us-washington |  s3.wdc.us |
| us-washington-cold |  s3.wdc.us |
| us-washington-flex |  s3.wdc.us |
| us-washington-smart |  s3.wdc.us |
| us-washington-vault |  s3.wdc.us |
| us-washington-standard |  s3.wdc.us |
| wdc-us-geo |  s3.wdc.us |
| wdc-us-geo-cold |  s3.wdc.us |
| wdc-us-geo-flex |  s3.wdc.us |
| wdc-us-geo-smart |  s3.wdc.us |
| wdc-us-geo-vault |  s3.wdc.us |
| wdc-us-geo-standard |  s3.wdc.us |
| us-south |  s3.us-south |
| us-south-cold |  s3.us-south |
| us-south-flex |  s3.us-south |
| us-south-smart |  s3.us-south |
| us-south-vault |  s3.us-south |
| us-south-standard |  s3.us-south |
| us-east |  s3.us-east |
| us-east-standard |  s3.us-east |
| us-east-cold |  s3.us-east |
| us-east-flex |  s3.us-east |
| us-east-smart |  s3.us-east |
| us-east-vault |  s3.us-east |
| eu |  s3.eu |
| eu-cold |  s3.eu |
| eu-flex |  s3.eu |
| eu-smart |  s3.eu |
| eu-vault |  s3.eu |
| eu-standard |  s3.eu |
| eu-geo |  s3.eu |
| eu-geo-cold |  s3.eu |
| eu-geo-flex |  s3.eu |
| eu-geo-smart |  s3.eu |
| eu-geo-vault |  s3.eu |
| eu-geo-standard |  s3.eu |
| eu-amsterdam |  s3.ams.eu |
| eu-amsterdam-cold |  s3.ams.eu |
| eu-amsterdam-flex |  s3.ams.eu |
| eu-amsterdam-smart |  s3.ams.eu |
| eu-amsterdam-vault |  s3.ams.eu |
| eu-amsterdam-standard |  s3.ams.eu |
| ams-eu-geo |  s3.ams.eu |
| ams-eu-geo-cold |  s3.ams.eu |
| ams-eu-geo-flex |  s3.ams.eu |
| ams-eu-geo-smart |  s3.ams.eu |
| ams-eu-geo-vault |  s3.ams.eu |
| ams-eu-geo-standard |  s3.ams.eu |
| eu-frankfurt |  s3.fra.eu |
| eu-frankfurt-cold |  s3.fra.eu |
| eu-frankfurt-flex |  s3.fra.eu |
| eu-frankfurt-smart |  s3.fra.eu |
| eu-frankfurt-vault |  s3.fra.eu |
| eu-frankfurt-standard |  s3.fra.eu |
| fra-eu-geo |  s3.fra.eu |
| fra-eu-geo-cold |  s3.fra.eu |
| fra-eu-geo-flex |  s3.fra.eu |
| fra-eu-geo-smart |  s3.fra.eu |
| fra-eu-geo-vault |  s3.fra.eu |
| fra-eu-geo-standard |  s3.fra.eu |
| eu-milan |  s3.mil.eu |
| eu-milan-cold |  s3.mil.eu |
| eu-milan-flex |  s3.mil.eu |
| eu-milan-smart |  s3.mil.eu |
| eu-milan-vault |  s3.mil.eu |
| eu-milan-standard |  s3.mil.eu |
| mil-eu-geo |  s3.mil.eu |
| mil-eu-geo-cold |  s3.mil.eu |
| mil-eu-geo-flex |  s3.mil.eu |
| mil-eu-geo-smart |  s3.mil.eu |
| mil-eu-geo-vault |  s3.mil.eu |
| mil-eu-geo-standard |  s3.mil.eu |
| eu-gb |  s3.eu-gb |
| eu-gb-cold |  s3.eu-gb |
| eu-gb-flex |  s3.eu-gb |
| eu-gb-smart |  s3.eu-gb |
| eu-gb-vault |  s3.eu-gb |
| eu-gb-standard |  s3.eu-gb |
| eu-germany |  s3.eu-de |
| eu-germany-cold |  s3.eu-de |
| eu-germany-flex |  s3.eu-de |
| eu-germany-smart |  s3.eu-de |
| eu-germany-vault |  s3.eu-de |
| eu-germany-standard |  s3.eu-de |
| eu-de |  s3.eu-de |
| eu-de-cold |  s3.eu-de |
| eu-de-flex |  s3.eu-de |
| eu-de-smart |  s3.eu-de |
| eu-de-vault |  s3.eu-de |
| eu-de-standard |  s3.eu-de |
| ap |  s3.ap |
| ap-cold |  s3.ap |
| ap-flex |  s3.ap |
| ap-smart |  s3.ap |
| ap-vault |  s3.ap |
| ap-standard |  s3.ap |
| ap-geo |  s3.ap |
| ap-geo-cold |  s3.ap |
| ap-geo-flex |  s3.ap |
| ap-geo-smart |  s3.ap |
| ap-geo-vault |  s3.ap |
| ap-geo-standard |  s3.ap |
| ap-tokyo |  s3.tok.ap |
| ap-tokyo-cold |  s3.tok.ap |
| ap-tokyo-flex |  s3.tok.ap |
| ap-tokyo-smart |  s3.tok.ap |
| ap-tokyo-vault |  s3.tok.ap |
| ap-tokyo-standard |  s3.tok.ap |
| tok-ap-geo |  s3.tok.ap |
| tok-ap-geo-cold |  s3.tok.ap |
| tok-ap-geo-flex |  s3.tok.ap |
| tok-ap-geo-smart |  s3.tok.ap |
| tok-ap-geo-vault |  s3.tok.ap |
| tok-ap-geo-standard |  s3.tok.ap |
| ap-seoul |  s3.seo.ap |
| ap-seoul-cold |  s3.seo.ap |
| ap-seoul-flex |  s3.seo.ap |
| ap-seoul-smart |  s3.seo.ap |
| ap-seoul-vault |  s3.seo.ap |
| ap-seoul-standard |  s3.seo.ap |
| seo-ap-geo |  s3.seo.ap |
| seo-ap-geo-cold |  s3.seo.ap |
| seo-ap-geo-flex |  s3.seo.ap |
| seo-ap-geo-smart |  s3.seo.ap |
| seo-ap-geo-vault |  s3.seo.ap |
| seo-ap-geo-standard |  s3.seo.ap |
| ap-hongkong |  s3.hkg.ap |
| ap-hongkong-cold |  s3.hkg.ap |
| ap-hongkong-flex |  s3.hkg.ap |
| ap-hongkong-smart |  s3.hkg.ap |
| ap-hongkong-vault |  s3.hkg.ap |
| ap-hongkong-standard |  s3.hkg.ap |
| hkg-ap-geo |  s3.hkg.ap |
| hkg-ap-geo-cold |  s3.hkg.ap |
| hkg-ap-geo-flex |  s3.hkg.ap |
| hkg-ap-geo-smart |  s3.hkg.ap |
| hkg-ap-geo-vault |  s3.hkg.ap |
| hkg-ap-geo-standard |  s3.hkg.ap |
| ap-japan |  s3.jp-tok |
| ap-japan-cold |  s3.jp-tok |
| ap-japan-flex |  s3.jp-tok |
| ap-japan-smart |  s3.jp-tok |
| ap-japan-vault |  s3.jp-tok |
| ap-japan-standard |  s3.jp-tok |
| jp-osa |  s3.jp-osa |
| jp-osa-cold |  s3.jp-osa |
| jp-osa-flex |  s3.jp-osa |
| jp-osa-smart |  s3.jp-osa |
| jp-osa-vault |  s3.jp-osa |
| jp-osa-standard |  s3.jp-osa |
| jp-tok |  s3.jp-tok |
| jp-tok-cold |  s3.jp-tok |
| jp-tok-flex |  s3.jp-tok |
| jp-tok-smart |  s3.jp-tok |
| jp-tok-vault |  s3.jp-tok |
| jp-tok-standard |  s3.jp-tok |
| ap-sydney |  s3.au-syd |
| ap-sydney-cold |  s3.au-syd |
| ap-sydney-flex |  s3.au-syd |
| ap-sydney-smart |  s3.au-syd |
| ap-sydney-vault |  s3.au-syd |
| ap-sydney-standard |  s3.au-syd |
| au-syd |  s3.au-syd |
| au-syd-cold |  s3.au-syd |
| au-syd-flex |  s3.au-syd |
| au-syd-smart |  s3.au-syd |
| au-syd-vault |  s3.au-syd |
| au-syd-standard |  s3.au-syd |
| ams03 |  s3.ams03 |
| ams03-cold |  s3.ams03 |
| ams03-flex |  s3.ams03 |
| ams03-smart |  s3.ams03 |
| ams03-vault |  s3.ams03 |
| ams03-standard |  s3.ams03 |
| che01 |  s3.che01 |
| che01-cold |  s3.che01 |
| che01-flex |  s3.che01 |
| che01-smart |  s3.che01 |
| che01-vault |  s3.che01 |
| che01-standard |  s3.che01 |
| hkg02 |  s3.hkg02 |
| hkg02-cold |  s3.hkg02 |
| hkg02-flex |  s3.hkg02 |
| hkg02-smart |  s3.hkg02 |
| hkg02-vault |  s3.hkg02 |
| hkg02-standard |  s3.hkg02 |
| mel01 |  s3.mel01 |
| mel01-cold |  s3.mel01 |
| mel01-flex |  s3.mel01 |
| mel01-smart |  s3.mel01 |
| mel01-vault |  s3.mel01 |
| mel01-standard |  s3.mel01 |
| osl01 |  s3.osl01 |
| osl01-cold |  s3.osl01 |
| osl01-flex |  s3.osl01 |
| osl01-smart |  s3.osl01 |
| osl01-vault |  s3.osl01 |
| osl01-standard |  s3.osl01 |
| sao01 |  s3.sao01 |
| sao01-cold |  s3.sao01 |
| sao01-flex |  s3.sao01 |
| sao01-smart |  s3.sao01 |
| sao01-vault |  s3.sao01 |
| sao01-standard |  s3.sao01 |
| tor01 |  s3.tor01 |
| tor01-cold |  s3.tor01 |
| tor01-flex |  s3.tor01 |
| tor01-smart |  s3.tor01 |
| tor01-vault |  s3.tor01 |
| tor01-standard |  s3.tor01 |
| seo01 |  s3.seo01 |
| seo01-cold |  s3.seo01 |
| seo01-flex |  s3.seo01 |
| seo01-smart |  s3.seo01 |
| seo01-vault |  s3.seo01 |
| seo01-standard |  s3.seo01 |
| sng01 |  s3.sng01 |
| sng01-cold |  s3.sng01 |
| sng01-flex |  s3.sng01 |
| sng01-smart |  s3.sng01 |
| sng01-vault |  s3.sng01 |
| sng01-standard |  s3.sng01 |
| mon01 |  s3.mon01 |
| mon01-cold |  s3.mon01 |
| mon01-flex |  s3.mon01 |
| mon01-smart |  s3.mon01 |
| mon01-vault |  s3.mon01 |
| mon01-standard |  s3.mon01 |
| mex01 |  s3.mex01 |
| mex01-cold |  s3.mex01 |
| mex01-flex |  s3.mex01 |
| mex01-smart |  s3.mex01 |
| mex01-vault |  s3.mex01 |
| mex01-standard |  s3.mex01 |
| mil01 |  s3.mil01 |
| mil01-cold |  s3.mil01 |
| mil01-flex |  s3.mil01 |
| mil01-smart |  s3.mil01 |
| mil01-vault |  s3.mil01 |
| mil01-standard |  s3.mil01 |
| par01 |  s3.par01 |
| par01-cold |  s3.par01 |
| par01-flex |  s3.par01 |
| par01-smart |  s3.par01 |
| par01-vault |  s3.par01 |
| par01-standard |  s3.par01 |
| sjc04 |  s3.sjc04 |
| sjc04-cold |  s3.sjc04 |
| sjc04-flex |  s3.sjc04 |
| sjc04-smart |  s3.sjc04 |
| sjc04-vault |  s3.sjc04 |
| sjc04-standard |  s3.sjc04 |
| ca-tor |  s3.ca-tor |
| ca-tor-cold |  s3.ca-tor |
| ca-tor-flex |  s3.ca-tor |
| ca-tor-smart |  s3.ca-tor |
| ca-tor-vault |  s3.ca-tor |
| ca-tor-standard |  s3.ca-tor |
| br-sao |  s3.br-sao |
| br-sao-cold |  s3.br-sao |
| br-sao-flex |  s3.br-sao |
| br-sao-smart |  s3.br-sao |
| br-sao-vault |  s3.br-sao |
| br-sao-standard |  s3.br-sao |

<!-- 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 -->