Upload Custom Jdbc Drivers Connection

POST/api/v2/connectivity/connections/{connectionRid}/uploadCustomJdbcDrivers

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

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.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-connection-write.

Path parameters

connectionRid

string

The Resource Identifier (RID) of a Connection (also known as a source).

Query parameters

fileName

string

The file name of the uploaded JDBC driver. Must end with .jar

preview

boolean

optional

Enables the use of preview functionality.

Request body

body

string

Response body

Connection

object

Hide child attributes

rid

string

The Resource Identifier (RID) of a Connection (also known as a source).

parentFolderRid

string

The unique resource identifier (RID) of a Folder.

displayName

string

The display name of the Connection. The display name must not be blank.

exportSettings

object

The export settings of a Connection.

Show child attributes

configuration

union

Show child attributes

Examples

Request

Copied!

curl -X POST \
\t-H "Content-type: application/octet-stream" \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/uploadCustomJdbcDrivers?fileName=cdata.jdbc.oracle.jar&preview=true" \
	--data-binary '@/path/to/file'

Response

Copied!

{
  "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
  "configuration": {
    "type": "jdbc",
    "url": "jdbc:postgresql://localhost:5432/test",
    "driverClass": "org.postgresql.Driver"
  },
  "displayName": "Connection to my external system",
  "exportSettings": {
    "exportsEnabled": true,
    "exportEnabledWithoutMarkingsValidation": false
  },
  "rid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"
}

Error responses

Error Name
`UploadCustomJdbcDriversConnectionPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not uploadCustomJdbcDrivers the Connection.
	Parameters	`connectionRid`
`ConnectionNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Connection could not be found.
	Parameters	`connectionRid`

See Errors for a general overview of errors in the platform.