• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationAvailable connectorsIBM Cloud Data Engine

    IBM Cloud Data Engine

    The IBM Cloud Data Engine connector is a Palantir-provided driver for IBM Cloud Data Engine.

    To create a new IBM Cloud Data Engine source, follow the standard setup flow for Palantir-provided drivers, 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 ↗.

    Configuration

    The properties below are mandatory or recommended.

    PropertyRequired?DescriptionDefault
    ApiKey ↗MandatoryThe API Key used to identify the user to IBM Cloud.—
    CloudObjectStorageCRN ↗RecommendedThe CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud.—
    InitiateOAuth ↗RecommendedSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.REFRESH
    SqlQueryCRN ↗RecommendedThe CRN which uniquely identifies your SQL Query instance in IBM Cloud.—

    Networking

    The table below lists the domains that the source needs to be able to access in order to successfully 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.

    DomainRequired
    iam.bluemix.netAlways
    api.dataengine.cloud.ibm.comAlways. New v3 endpoint, most likely required/used unless an older version of the driver
    <Region>.cloud-object-storage.appdomain.cloudAlways. Region connection property is mapped (may also be returned by IBM or part of CRN)
    resource-controller.cloud.ibm.comIf CRN is not provided
    sql-api.ng.bluemix.netOld v2 endpoint replaced by api.dataengine.cloud.ibm.com

    Region mappings

    Use the following region mapping to complete the domain URL:

    RegionEndpoint
    uss3.us
    us-standards3.us
    us-colds3.us
    us-flexs3.us
    us-smarts3.us
    us-vaults3.us
    us-geos3.us
    us-geo-colds3.us
    us-geo-flexs3.us
    us-geo-smarts3.us
    us-geo-vaults3.us
    us-geo-standards3.us
    us-dallass3.dal.us
    us-dallas-colds3.dal.us
    us-dallas-flexs3.dal.us
    us-dallas-smarts3.dal.us
    us-dallas-vaults3.dal.us
    us-dallas-standards3.dal.us
    dal-us-geos3.dal.us
    dal-us-geo-colds3.dal.us
    dal-us-geo-flexs3.dal.us
    dal-us-geo-smarts3.dal.us
    dal-us-geo-vaults3.dal.us
    dal-us-geo-standards3.dal.us
    us-sanjoses3.sjc.us
    us-sanjose-colds3.sjc.us
    us-sanjose-flexs3.sjc.us
    us-sanjose-smarts3.sjc.us
    us-sanjose-vaults3.sjc.us
    us-sanjose-standards3.sjc.us
    sjc-us-geos3.sjc.us
    sjc-us-geo-colds3.sjc.us
    sjc-us-geo-flexs3.sjc.us
    sjc-us-geo-smarts3.sjc.us
    sjc-us-geo-vaults3.sjc.us
    sjc-us-geo-standards3.sjc.us
    us-washingtons3.wdc.us
    us-washington-colds3.wdc.us
    us-washington-flexs3.wdc.us
    us-washington-smarts3.wdc.us
    us-washington-vaults3.wdc.us
    us-washington-standards3.wdc.us
    wdc-us-geos3.wdc.us
    wdc-us-geo-colds3.wdc.us
    wdc-us-geo-flexs3.wdc.us
    wdc-us-geo-smarts3.wdc.us
    wdc-us-geo-vaults3.wdc.us
    wdc-us-geo-standards3.wdc.us
    us-souths3.us-south
    us-south-colds3.us-south
    us-south-flexs3.us-south
    us-south-smarts3.us-south
    us-south-vaults3.us-south
    us-south-standards3.us-south
    us-easts3.us-east
    us-east-standards3.us-east
    us-east-colds3.us-east
    us-east-flexs3.us-east
    us-east-smarts3.us-east
    us-east-vaults3.us-east
    eus3.eu
    eu-colds3.eu
    eu-flexs3.eu
    eu-smarts3.eu
    eu-vaults3.eu
    eu-standards3.eu
    eu-geos3.eu
    eu-geo-colds3.eu
    eu-geo-flexs3.eu
    eu-geo-smarts3.eu
    eu-geo-vaults3.eu
    eu-geo-standards3.eu
    eu-amsterdams3.ams.eu
    eu-amsterdam-colds3.ams.eu
    eu-amsterdam-flexs3.ams.eu
    eu-amsterdam-smarts3.ams.eu
    eu-amsterdam-vaults3.ams.eu
    eu-amsterdam-standards3.ams.eu
    ams-eu-geos3.ams.eu
    ams-eu-geo-colds3.ams.eu
    ams-eu-geo-flexs3.ams.eu
    ams-eu-geo-smarts3.ams.eu
    ams-eu-geo-vaults3.ams.eu
    ams-eu-geo-standards3.ams.eu
    eu-frankfurts3.fra.eu
    eu-frankfurt-colds3.fra.eu
    eu-frankfurt-flexs3.fra.eu
    eu-frankfurt-smarts3.fra.eu
    eu-frankfurt-vaults3.fra.eu
    eu-frankfurt-standards3.fra.eu
    fra-eu-geos3.fra.eu
    fra-eu-geo-colds3.fra.eu
    fra-eu-geo-flexs3.fra.eu
    fra-eu-geo-smarts3.fra.eu
    fra-eu-geo-vaults3.fra.eu
    fra-eu-geo-standards3.fra.eu
    eu-milans3.mil.eu
    eu-milan-colds3.mil.eu
    eu-milan-flexs3.mil.eu
    eu-milan-smarts3.mil.eu
    eu-milan-vaults3.mil.eu
    eu-milan-standards3.mil.eu
    mil-eu-geos3.mil.eu
    mil-eu-geo-colds3.mil.eu
    mil-eu-geo-flexs3.mil.eu
    mil-eu-geo-smarts3.mil.eu
    mil-eu-geo-vaults3.mil.eu
    mil-eu-geo-standards3.mil.eu
    eu-gbs3.eu-gb
    eu-gb-colds3.eu-gb
    eu-gb-flexs3.eu-gb
    eu-gb-smarts3.eu-gb
    eu-gb-vaults3.eu-gb
    eu-gb-standards3.eu-gb
    eu-germanys3.eu-de
    eu-germany-colds3.eu-de
    eu-germany-flexs3.eu-de
    eu-germany-smarts3.eu-de
    eu-germany-vaults3.eu-de
    eu-germany-standards3.eu-de
    eu-des3.eu-de
    eu-de-colds3.eu-de
    eu-de-flexs3.eu-de
    eu-de-smarts3.eu-de
    eu-de-vaults3.eu-de
    eu-de-standards3.eu-de
    aps3.ap
    ap-colds3.ap
    ap-flexs3.ap
    ap-smarts3.ap
    ap-vaults3.ap
    ap-standards3.ap
    ap-geos3.ap
    ap-geo-colds3.ap
    ap-geo-flexs3.ap
    ap-geo-smarts3.ap
    ap-geo-vaults3.ap
    ap-geo-standards3.ap
    ap-tokyos3.tok.ap
    ap-tokyo-colds3.tok.ap
    ap-tokyo-flexs3.tok.ap
    ap-tokyo-smarts3.tok.ap
    ap-tokyo-vaults3.tok.ap
    ap-tokyo-standards3.tok.ap
    tok-ap-geos3.tok.ap
    tok-ap-geo-colds3.tok.ap
    tok-ap-geo-flexs3.tok.ap
    tok-ap-geo-smarts3.tok.ap
    tok-ap-geo-vaults3.tok.ap
    tok-ap-geo-standards3.tok.ap
    ap-seouls3.seo.ap
    ap-seoul-colds3.seo.ap
    ap-seoul-flexs3.seo.ap
    ap-seoul-smarts3.seo.ap
    ap-seoul-vaults3.seo.ap
    ap-seoul-standards3.seo.ap
    seo-ap-geos3.seo.ap
    seo-ap-geo-colds3.seo.ap
    seo-ap-geo-flexs3.seo.ap
    seo-ap-geo-smarts3.seo.ap
    seo-ap-geo-vaults3.seo.ap
    seo-ap-geo-standards3.seo.ap
    ap-hongkongs3.hkg.ap
    ap-hongkong-colds3.hkg.ap
    ap-hongkong-flexs3.hkg.ap
    ap-hongkong-smarts3.hkg.ap
    ap-hongkong-vaults3.hkg.ap
    ap-hongkong-standards3.hkg.ap
    hkg-ap-geos3.hkg.ap
    hkg-ap-geo-colds3.hkg.ap
    hkg-ap-geo-flexs3.hkg.ap
    hkg-ap-geo-smarts3.hkg.ap
    hkg-ap-geo-vaults3.hkg.ap
    hkg-ap-geo-standards3.hkg.ap
    ap-japans3.jp-tok
    ap-japan-colds3.jp-tok
    ap-japan-flexs3.jp-tok
    ap-japan-smarts3.jp-tok
    ap-japan-vaults3.jp-tok
    ap-japan-standards3.jp-tok
    jp-osas3.jp-osa
    jp-osa-colds3.jp-osa
    jp-osa-flexs3.jp-osa
    jp-osa-smarts3.jp-osa
    jp-osa-vaults3.jp-osa
    jp-osa-standards3.jp-osa
    jp-toks3.jp-tok
    jp-tok-colds3.jp-tok
    jp-tok-flexs3.jp-tok
    jp-tok-smarts3.jp-tok
    jp-tok-vaults3.jp-tok
    jp-tok-standards3.jp-tok
    ap-sydneys3.au-syd
    ap-sydney-colds3.au-syd
    ap-sydney-flexs3.au-syd
    ap-sydney-smarts3.au-syd
    ap-sydney-vaults3.au-syd
    ap-sydney-standards3.au-syd
    au-syds3.au-syd
    au-syd-colds3.au-syd
    au-syd-flexs3.au-syd
    au-syd-smarts3.au-syd
    au-syd-vaults3.au-syd
    au-syd-standards3.au-syd
    ams03s3.ams03
    ams03-colds3.ams03
    ams03-flexs3.ams03
    ams03-smarts3.ams03
    ams03-vaults3.ams03
    ams03-standards3.ams03
    che01s3.che01
    che01-colds3.che01
    che01-flexs3.che01
    che01-smarts3.che01
    che01-vaults3.che01
    che01-standards3.che01
    hkg02s3.hkg02
    hkg02-colds3.hkg02
    hkg02-flexs3.hkg02
    hkg02-smarts3.hkg02
    hkg02-vaults3.hkg02
    hkg02-standards3.hkg02
    mel01s3.mel01
    mel01-colds3.mel01
    mel01-flexs3.mel01
    mel01-smarts3.mel01
    mel01-vaults3.mel01
    mel01-standards3.mel01
    osl01s3.osl01
    osl01-colds3.osl01
    osl01-flexs3.osl01
    osl01-smarts3.osl01
    osl01-vaults3.osl01
    osl01-standards3.osl01
    sao01s3.sao01
    sao01-colds3.sao01
    sao01-flexs3.sao01
    sao01-smarts3.sao01
    sao01-vaults3.sao01
    sao01-standards3.sao01
    tor01s3.tor01
    tor01-colds3.tor01
    tor01-flexs3.tor01
    tor01-smarts3.tor01
    tor01-vaults3.tor01
    tor01-standards3.tor01
    seo01s3.seo01
    seo01-colds3.seo01
    seo01-flexs3.seo01
    seo01-smarts3.seo01
    seo01-vaults3.seo01
    seo01-standards3.seo01
    sng01s3.sng01
    sng01-colds3.sng01
    sng01-flexs3.sng01
    sng01-smarts3.sng01
    sng01-vaults3.sng01
    sng01-standards3.sng01
    mon01s3.mon01
    mon01-colds3.mon01
    mon01-flexs3.mon01
    mon01-smarts3.mon01
    mon01-vaults3.mon01
    mon01-standards3.mon01
    mex01s3.mex01
    mex01-colds3.mex01
    mex01-flexs3.mex01
    mex01-smarts3.mex01
    mex01-vaults3.mex01
    mex01-standards3.mex01
    mil01s3.mil01
    mil01-colds3.mil01
    mil01-flexs3.mil01
    mil01-smarts3.mil01
    mil01-vaults3.mil01
    mil01-standards3.mil01
    par01s3.par01
    par01-colds3.par01
    par01-flexs3.par01
    par01-smarts3.par01
    par01-vaults3.par01
    par01-standards3.par01
    sjc04s3.sjc04
    sjc04-colds3.sjc04
    sjc04-flexs3.sjc04
    sjc04-smarts3.sjc04
    sjc04-vaults3.sjc04
    sjc04-standards3.sjc04
    ca-tors3.ca-tor
    ca-tor-colds3.ca-tor
    ca-tor-flexs3.ca-tor
    ca-tor-smarts3.ca-tor
    ca-tor-vaults3.ca-tor
    ca-tor-standards3.ca-tor
    br-saos3.br-sao
    br-sao-colds3.br-sao
    br-sao-flexs3.br-sao
    br-sao-smarts3.br-sao
    br-sao-vaults3.br-sao
    br-sao-standards3.br-sao