Connection

Method	HTTP request	Release Stage
create	POST /v2/connectivity/connections	Stable
get	GET /v2/connectivity/connections/{connectionRid}	Stable
get_configuration	GET /v2/connectivity/connections/{connectionRid}/getConfiguration	Stable
get_configuration_batch	POST /v2/connectivity/connections/getConfigurationBatch	Stable
update_export_settings	POST /v2/connectivity/connections/{connectionRid}/updateExportSettings	Stable
update_secrets	POST /v2/connectivity/connections/{connectionRid}/updateSecrets	Stable
upload_custom_jdbc_drivers	POST /v2/connectivity/connections/{connectionRid}/uploadCustomJdbcDrivers	Stable

create

Creates a new Connection with a direct connection runtime.

Any secrets specified in the request body are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. They will stay in plaintext in memory until the garbage collection process cleans up the memory. The secrets are always stored encrypted on our servers. By using this endpoint, you acknowledge and accept any potential risks associated with the temporary in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should use the Foundry UI instead.

Parameters

Name	Type	Description
configuration	CreateConnectionRequestConnectionConfiguration
display_name	ConnectionDisplayName	The display name of the Connection. The display name must not be blank.
parent_folder_rid	FolderRid
worker	CreateConnectionRequestConnectionWorker

Return type

Connection

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# CreateConnectionRequestConnectionConfiguration
configuration = {
    "type": "jdbc",
    "url": "jdbc:postgresql://localhost:5432/test",
    "driverClass": "org.postgresql.Driver",
}
# ConnectionDisplayName | The display name of the Connection. The display name must not be blank.
display_name = "Connection to my external system"
# FolderRid
parent_folder_rid = "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"
# CreateConnectionRequestConnectionWorker
worker = None


try:
    api_response = client.connectivity.Connection.create(
        configuration=configuration,
        display_name=display_name,
        parent_folder_rid=parent_folder_rid,
        worker=worker,
    )
    print("The create response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Connection.create: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Connection	The created Connection	application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

Get the Connection with the specified rid.

Parameters

Name	Type	Description	Notes
connection_rid	ConnectionRid

Return type

Connection

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None


try:
    api_response = client.connectivity.Connection.get(connection_rid)
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Connection.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Connection		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_configuration

Retrieves the ConnectionConfiguration of the Connection itself. This operation is intended for use when other Connection data is not required, providing a lighter-weight alternative to getConnection operation.

Parameters

Name	Type	Description	Notes
connection_rid	ConnectionRid

Return type

ConnectionConfiguration

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None


try:
    api_response = client.connectivity.Connection.get_configuration(connection_rid)
    print("The get_configuration response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Connection.get_configuration: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	ConnectionConfiguration		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_configuration_batch

Returns a map of Connection RIDs to their corresponding configurations. Connections are filtered from the response if they don't exist or the requesting token lacks the required permissions.

The maximum batch size for this endpoint is 200.

Parameters

Name	Type	Description	Notes
body	List[GetConfigurationConnectionsBatchRequestElement]	Body of the request

Return type

GetConfigurationConnectionsBatchResponse

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# List[GetConfigurationConnectionsBatchRequestElement] | Body of the request
body = [{"connectionRid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"}]


try:
    api_response = client.connectivity.Connection.get_configuration_batch(body)
    print("The get_configuration_batch response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Connection.get_configuration_batch: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	GetConfigurationConnectionsBatchResponse		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_export_settings

Updates the export settings on the Connection. Only users with Information Security Officer role can modify the export settings.

Parameters

Name	Type	Description	Notes
connection_rid	ConnectionRid
export_settings	ConnectionExportSettings

Return type

None

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# ConnectionExportSettings
export_settings = {"exportsEnabled": True, "exportEnabledWithoutMarkingsValidation": False}


try:
    api_response = client.connectivity.Connection.update_export_settings(
        connection_rid, export_settings=export_settings
    )
    print("The update_export_settings response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Connection.update_export_settings: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
204	None		None

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_secrets

Updates the secrets on the connection to the specified secret values. Secrets that are currently configured on the connection but are omitted in the request will remain unchanged.

Secrets are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. They will stay in plaintext in memory until the garbage collection process cleans up the memory. The secrets are always stored encrypted on our servers.

By using this endpoint, you acknowledge and accept any potential risks associated with the temporary in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should use the Foundry UI instead.

Parameters

Name	Type	Description	Notes
connection_rid	ConnectionRid
secrets	Dict[SecretName, PlaintextValue]	The secrets to be updated. The specified secret names must already be configured on the connection.

Return type

None

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# Dict[SecretName, PlaintextValue] | The secrets to be updated. The specified secret names must already be configured on the connection.
secrets = {"Password": "MySecretPassword"}


try:
    api_response = client.connectivity.Connection.update_secrets(connection_rid, secrets=secrets)
    print("The update_secrets response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Connection.update_secrets: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
204	None		None

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_custom_jdbc_drivers

Upload custom jdbc drivers to an existing JDBC connection. The body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.

Parameters

Name	Type	Description
connection_rid	ConnectionRid
body	bytes	Body of the request
file_name	str	The file name of the uploaded JDBC driver. Must end with .jar

Return type

Connection

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# bytes | Body of the request
body = None
# str | The file name of the uploaded JDBC driver. Must end with .jar
file_name = "cdata.jdbc.oracle.jar"


try:
    api_response = client.connectivity.Connection.upload_custom_jdbc_drivers(
        connection_rid, body, file_name=file_name
    )
    print("The upload_custom_jdbc_drivers response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Connection.upload_custom_jdbc_drivers: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Connection		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

Connection.md

Latest commit

History

Connection.md

File metadata and controls

Connection

create

Parameters

Return type

Example

Authorization

HTTP response details

get

Parameters

Return type

Example

Authorization

HTTP response details

get_configuration

Parameters

Return type

Example

Authorization

HTTP response details

get_configuration_batch

Parameters

Return type

Example

Authorization

HTTP response details

update_export_settings

Parameters

Return type

Example

Authorization

HTTP response details

update_secrets

Parameters

Return type

Example

Authorization

HTTP response details

upload_custom_jdbc_drivers

Parameters

Return type

Example

Authorization

HTTP response details