Skip to content
/
Update jdbc driver

Masking API (5.1.41)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.1.0.0).json
CC Engine APIs (2025.1.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0
https://help-api.delphix.com/masking/api/v5.1.41

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

databaseRuleset

Operations

domain

Operations

encryptionKey

Operations

environment

Operations

execution

Operations

executionComponent

Operations

executionEvent

Operations

sync

Operations

fileConnector

Operations

fileDownload

Operations

fileFieldMetadata

Operations

fileFormat

Operations

fileMetadata

Operations

fileRuleset

Operations

fileUpload

Operations

inventoryApproval

Operations

knowledgeBaseInfo

Operations

jdbcDriver

Operations

Get all JDBC drivers

Request

Security
api_key
Query
is_built_inboolean

Get only drivers that are built in to the engine when this is true and only user uploaded drivers when this is false

page_numberinteger(int64)

The page number for which to get JDBC drivers. This will default to the first page if excluded

Default 1
page_sizeinteger(int64)

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/jdbc-drivers?is_built_in=true&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(JdbcDriver)
Example: [{"driverName":"HANA driver","driverClassName":"com.sap.db.jdbc.Driver","fileReferenceId":"delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create Jdbc Driver

Request

Security
api_key
Bodyapplication/jsonrequired

The jdbc driver details.

driverNamestring<= 255 charactersrequired

The name of the driver.

Example: "HANA driver"
driverClassNamestring<= 255 charactersrequired

The name of the class to use.

Example: "com.sap.db.jdbc.Driver"
descriptionstring<= 1024 characters

A description of the driver.

fileReferenceIdstring

The file references ID of the uploaded zip file

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
driverSupportIdinteger(int64)

The ID of the Driver Support plugin to use for this JDBC Driver.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/jdbc-drivers \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "driverName": "HANA driver",
    "driverClassName": "com.sap.db.jdbc.Driver",
    "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
  }'

Responses

Success

Bodyapplication/json
jdbcDriverIdinteger(int32)read-only

The ID number of the driver. This field is auto-generated by the Masking Engine.

driverNamestring<= 255 charactersrequired

The name of the driver.

Example: "HANA driver"
driverClassNamestring<= 255 charactersrequired

The name of the class to use.

Example: "com.sap.db.jdbc.Driver"
descriptionstring<= 1024 characters

A description of the driver.

versionstring<= 255 charactersread-only

The version of the driver.

uploadedBystring<= 255 charactersread-only

The name of the user that uploaded the driver

uploadDatestring(date-time)read-only

The date the driver was updated.

checksumstringread-only

The md5 checksum of the uploaded driver.

builtInbooleanread-only

Whether this is a JDBC driver that is supported natively by the engine.

loggerInstalledbooleanread-only

Whether a logger is successfully installed.

fileReferenceIdstring

The file references ID of the uploaded zip file

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
driverSupportIdinteger(int64)

The ID of the Driver Support plugin to use for this JDBC Driver.

Response
application/json
{
  "driverName": "HANA driver",
  "driverClassName": "com.sap.db.jdbc.Driver",
  "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Get JDBC driver by ID

Request

Security
api_key
Path
jdbcDriverIdinteger(int32)required

The ID of the JDBC driver to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/jdbc-drivers/{jdbcDriverId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
jdbcDriverIdinteger(int32)read-only

The ID number of the driver. This field is auto-generated by the Masking Engine.

driverNamestring<= 255 charactersrequired

The name of the driver.

Example: "HANA driver"
driverClassNamestring<= 255 charactersrequired

The name of the class to use.

Example: "com.sap.db.jdbc.Driver"
descriptionstring<= 1024 characters

A description of the driver.

versionstring<= 255 charactersread-only

The version of the driver.

uploadedBystring<= 255 charactersread-only

The name of the user that uploaded the driver

uploadDatestring(date-time)read-only

The date the driver was updated.

checksumstringread-only

The md5 checksum of the uploaded driver.

builtInbooleanread-only

Whether this is a JDBC driver that is supported natively by the engine.

loggerInstalledbooleanread-only

Whether a logger is successfully installed.

fileReferenceIdstring

The file references ID of the uploaded zip file

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
driverSupportIdinteger(int64)

The ID of the Driver Support plugin to use for this JDBC Driver.

Response
application/json
{
  "driverName": "HANA driver",
  "driverClassName": "com.sap.db.jdbc.Driver",
  "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Update jdbc driver

Request

Security
api_key
Path
jdbcDriverIdinteger(int32)required

The ID of the JDBC driver to update

Bodyapplication/jsonrequired

The jdbc driver details.

driverNamestring<= 255 charactersrequired

The name of the driver.

Example: "HANA driver"
driverClassNamestring<= 255 charactersrequired

The name of the class to use.

Example: "com.sap.db.jdbc.Driver"
descriptionstring<= 1024 characters

A description of the driver.

fileReferenceIdstring

The file references ID of the uploaded zip file

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
driverSupportIdinteger(int64)

The ID of the Driver Support plugin to use for this JDBC Driver.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/jdbc-drivers/{jdbcDriverId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "driverName": "HANA driver",
    "driverClassName": "com.sap.db.jdbc.Driver",
    "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
  }'

Responses

Success

Bodyapplication/json
jdbcDriverIdinteger(int32)read-only

The ID number of the driver. This field is auto-generated by the Masking Engine.

driverNamestring<= 255 charactersrequired

The name of the driver.

Example: "HANA driver"
driverClassNamestring<= 255 charactersrequired

The name of the class to use.

Example: "com.sap.db.jdbc.Driver"
descriptionstring<= 1024 characters

A description of the driver.

versionstring<= 255 charactersread-only

The version of the driver.

uploadedBystring<= 255 charactersread-only

The name of the user that uploaded the driver

uploadDatestring(date-time)read-only

The date the driver was updated.

checksumstringread-only

The md5 checksum of the uploaded driver.

builtInbooleanread-only

Whether this is a JDBC driver that is supported natively by the engine.

loggerInstalledbooleanread-only

Whether a logger is successfully installed.

fileReferenceIdstring

The file references ID of the uploaded zip file

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
driverSupportIdinteger(int64)

The ID of the Driver Support plugin to use for this JDBC Driver.

Response
application/json
{
  "driverName": "HANA driver",
  "driverClassName": "com.sap.db.jdbc.Driver",
  "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Delete JDBC driver by ID

Request

Security
api_key
Path
jdbcDriverIdinteger(int32)required

The ID of the JDBC driver to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/jdbc-drivers/{jdbcDriverId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

license

Operations

login

Operations

mainframeDatasetConnector

Operations

mainframeDatasetFieldMetadata

Operations

mainframeDatasetFormat

Operations

mainframeDatasetMetadata

Operations

mainframeDatasetRecordType

Operations

mainframeDatasetRuleset

Operations

mappingAlgorithm

Operations

maskingJob

Operations

monitoring

Operations

mountFilesystem

Operations

nonConformantDataSample

Operations

passwordVault

Operations

plugin

Operations

profileJob

Operations

profileSet

Operations

profileResultDatabase

Operations

profileResultFile

Operations

profileResultMainframe

Operations

recordType

Operations

recordTypeQualifier

Operations

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

tokenizationJob

Operations

user

Operations