Skip to content
/
Get database connector by...

Masking API (5.1.45)

Schema for the Continuous Compliance Engine API

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

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

Get all database connectors

Request

Security
api_key
Query
page_numberinteger(int64)

The page number for which to get database connectors. 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

environment_idinteger(int32)

The ID of the environment to get all database connectors from

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors?page_number=1&page_size=0&environment_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(DatabaseConnector)
Example: [{"connectorName":"Con123","databaseType":"ORACLE","environmentId":1,"host":"europa.delphix.com","password":"Pass_123","port":1521,"schemaName":"MASKER","sid":"TEST","username":"MASKER"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create database connector

Request

Security
api_key
Bodyapplication/jsonrequired

The database connector to create

connectorNamestring<= 255 characters

The name of the connector.

Example: "Con123"
databaseTypestring

The type of database the connector will connect to.

Enum"AURORA_POSTGRES""DB2""DB2_ISERIES""DB2_MAINFRAME""EXTENDED""GENERIC""MARIADB""MSSQL""MYSQL""ORACLE"
Example: "ORACLE"
environmentIdinteger(int32)

The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.

Example: 1
customDriverNamestring<= 255 characters

The name of the custom driver to use. Only used for database type 'GENERIC'.

databaseNamestring<= 255 characters

The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

hoststring<= 500 characters

The host name or IP address where the database is located.

Example: "europa.delphix.com"
instanceNamestring<= 50 characters

The name of the database instance. Only used for database type 'MSSQL'.

jdbcstring

The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.

passwordstring<= 255 characters

The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Pass_123"
portinteger[ 0 .. 65535 ]

The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.

Example: 1521
schemaNamestring<= 255 characters

The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.

Example: "MASKER"
sidstring<= 255 characters

The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.

Example: "TEST"
usernamestring<= 255 characters

The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.

Example: "MASKER"
kerberosAuthboolean

Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance

Default false
servicePrincipalstring<= 256 characters

The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

jdbcDriverIdinteger(int32)

The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

enableLoggerboolean

Whether to enable the logger. This is exclusively used for extended connectors.

fileReferenceIdstring

The reference to the uploaded connection property file.

credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "Con123",
    "databaseType": "ORACLE",
    "environmentId": 1,
    "host": "europa.delphix.com",
    "password": "Pass_123",
    "port": 1521,
    "schemaName": "MASKER",
    "sid": "TEST",
    "username": "MASKER"
  }'

Responses

Success

Bodyapplication/json
databaseConnectorIdinteger(int32)read-only

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

connectorNamestring<= 255 characters

The name of the connector.

Example: "Con123"
databaseTypestring

The type of database the connector will connect to.

Enum"AURORA_POSTGRES""DB2""DB2_ISERIES""DB2_MAINFRAME""EXTENDED""GENERIC""MARIADB""MSSQL""MYSQL""ORACLE"
Example: "ORACLE"
environmentIdinteger(int32)

The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.

Example: 1
customDriverNamestring<= 255 characters

The name of the custom driver to use. Only used for database type 'GENERIC'.

databaseNamestring<= 255 characters

The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

hoststring<= 500 characters

The host name or IP address where the database is located.

Example: "europa.delphix.com"
instanceNamestring<= 50 characters

The name of the database instance. Only used for database type 'MSSQL'.

jdbcstring

The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.

passwordstring<= 255 characters

The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Pass_123"
portinteger[ 0 .. 65535 ]

The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.

Example: 1521
schemaNamestring<= 255 characters

The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.

Example: "MASKER"
sidstring<= 255 characters

The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.

Example: "TEST"
usernamestring<= 255 characters

The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.

Example: "MASKER"
kerberosAuthboolean

Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance

Default false
servicePrincipalstring<= 256 characters

The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

jdbcDriverIdinteger(int32)

The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

enableLoggerboolean

Whether to enable the logger. This is exclusively used for extended connectors.

fileReferenceIdstring

The reference to the uploaded connection property file.

passwordVaultAuthbooleanread-only

Whether the connector uses password vault for authentication or not. This is a read-only field, determined by if credentialPathId is provided.

credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

authPresentstringread-only

Denotes whether authentication is present or not for this connector, UI only field

Response
application/json
{
  "connectorName": "Con123",
  "databaseType": "ORACLE",
  "environmentId": 1,
  "host": "europa.delphix.com",
  "password": "Pass_123",
  "port": 1521,
  "schemaName": "MASKER",
  "sid": "TEST",
  "username": "MASKER"
}

Get database connector by ID

Request

Security
api_key
Path
databaseConnectorIdinteger(int32)required

The ID of the database connector to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors/{databaseConnectorId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
databaseConnectorIdinteger(int32)read-only

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

connectorNamestring<= 255 characters

The name of the connector.

Example: "Con123"
databaseTypestring

The type of database the connector will connect to.

Enum"AURORA_POSTGRES""DB2""DB2_ISERIES""DB2_MAINFRAME""EXTENDED""GENERIC""MARIADB""MSSQL""MYSQL""ORACLE"
Example: "ORACLE"
environmentIdinteger(int32)

The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.

Example: 1
customDriverNamestring<= 255 characters

The name of the custom driver to use. Only used for database type 'GENERIC'.

databaseNamestring<= 255 characters

The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

hoststring<= 500 characters

The host name or IP address where the database is located.

Example: "europa.delphix.com"
instanceNamestring<= 50 characters

The name of the database instance. Only used for database type 'MSSQL'.

jdbcstring

The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.

passwordstring<= 255 characters

The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Pass_123"
portinteger[ 0 .. 65535 ]

The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.

Example: 1521
schemaNamestring<= 255 characters

The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.

Example: "MASKER"
sidstring<= 255 characters

The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.

Example: "TEST"
usernamestring<= 255 characters

The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.

Example: "MASKER"
kerberosAuthboolean

Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance

Default false
servicePrincipalstring<= 256 characters

The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

jdbcDriverIdinteger(int32)

The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

enableLoggerboolean

Whether to enable the logger. This is exclusively used for extended connectors.

fileReferenceIdstring

The reference to the uploaded connection property file.

passwordVaultAuthbooleanread-only

Whether the connector uses password vault for authentication or not. This is a read-only field, determined by if credentialPathId is provided.

credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

authPresentstringread-only

Denotes whether authentication is present or not for this connector, UI only field

Response
application/json
{
  "connectorName": "Con123",
  "databaseType": "ORACLE",
  "environmentId": 1,
  "host": "europa.delphix.com",
  "password": "Pass_123",
  "port": 1521,
  "schemaName": "MASKER",
  "sid": "TEST",
  "username": "MASKER"
}

Update database connector by ID

Request

Security
api_key
Path
databaseConnectorIdinteger(int32)required

The ID of the database connector to update

Bodyapplication/jsonrequired

The updated database connector

connectorNamestring<= 255 characters

The name of the connector.

Example: "Con123"
databaseTypestring

The type of database the connector will connect to.

Enum"AURORA_POSTGRES""DB2""DB2_ISERIES""DB2_MAINFRAME""EXTENDED""GENERIC""MARIADB""MSSQL""MYSQL""ORACLE"
Example: "ORACLE"
environmentIdinteger(int32)

The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.

Example: 1
customDriverNamestring<= 255 characters

The name of the custom driver to use. Only used for database type 'GENERIC'.

databaseNamestring<= 255 characters

The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

hoststring<= 500 characters

The host name or IP address where the database is located.

Example: "europa.delphix.com"
instanceNamestring<= 50 characters

The name of the database instance. Only used for database type 'MSSQL'.

jdbcstring

The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.

passwordstring<= 255 characters

The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Pass_123"
portinteger[ 0 .. 65535 ]

The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.

Example: 1521
schemaNamestring<= 255 characters

The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.

Example: "MASKER"
sidstring<= 255 characters

The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.

Example: "TEST"
usernamestring<= 255 characters

The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.

Example: "MASKER"
kerberosAuthboolean

Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance

Default false
servicePrincipalstring<= 256 characters

The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

jdbcDriverIdinteger(int32)

The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

enableLoggerboolean

Whether to enable the logger. This is exclusively used for extended connectors.

fileReferenceIdstring

The reference to the uploaded connection property file.

credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors/{databaseConnectorId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "Con123",
    "databaseType": "ORACLE",
    "environmentId": 1,
    "host": "europa.delphix.com",
    "password": "Pass_123",
    "port": 1521,
    "schemaName": "MASKER",
    "sid": "TEST",
    "username": "MASKER"
  }'

Responses

Success

Bodyapplication/json
databaseConnectorIdinteger(int32)read-only

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

connectorNamestring<= 255 characters

The name of the connector.

Example: "Con123"
databaseTypestring

The type of database the connector will connect to.

Enum"AURORA_POSTGRES""DB2""DB2_ISERIES""DB2_MAINFRAME""EXTENDED""GENERIC""MARIADB""MSSQL""MYSQL""ORACLE"
Example: "ORACLE"
environmentIdinteger(int32)

The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.

Example: 1
customDriverNamestring<= 255 characters

The name of the custom driver to use. Only used for database type 'GENERIC'.

databaseNamestring<= 255 characters

The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

hoststring<= 500 characters

The host name or IP address where the database is located.

Example: "europa.delphix.com"
instanceNamestring<= 50 characters

The name of the database instance. Only used for database type 'MSSQL'.

jdbcstring

The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.

passwordstring<= 255 characters

The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Pass_123"
portinteger[ 0 .. 65535 ]

The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.

Example: 1521
schemaNamestring<= 255 characters

The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.

Example: "MASKER"
sidstring<= 255 characters

The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.

Example: "TEST"
usernamestring<= 255 characters

The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.

Example: "MASKER"
kerberosAuthboolean

Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance

Default false
servicePrincipalstring<= 256 characters

The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

jdbcDriverIdinteger(int32)

The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

enableLoggerboolean

Whether to enable the logger. This is exclusively used for extended connectors.

fileReferenceIdstring

The reference to the uploaded connection property file.

passwordVaultAuthbooleanread-only

Whether the connector uses password vault for authentication or not. This is a read-only field, determined by if credentialPathId is provided.

credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

authPresentstringread-only

Denotes whether authentication is present or not for this connector, UI only field

Response
application/json
{
  "connectorName": "Con123",
  "databaseType": "ORACLE",
  "environmentId": 1,
  "host": "europa.delphix.com",
  "password": "Pass_123",
  "port": 1521,
  "schemaName": "MASKER",
  "sid": "TEST",
  "username": "MASKER"
}

Delete database connector by ID

Request

Deletes database connector with given ID. This will also delete all rule sets and jobs which are using this connector.

Security
api_key
Path
databaseConnectorIdinteger(int32)required

The ID of the database connector to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors/{databaseConnectorId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Fetch all accessible table names

Request

Note that only the names of tables that are accessible by the database user will be returned

Security
api_key
Path
databaseConnectorIdinteger(int32)required

The ID of the database connector to fetch the tables for

Query
hideExistingboolean

This flag specifies fetching only table names that are not already part of a particular ruleset.

rulesetIdinteger(int32)

Ruleset ID to check if tables is already added. Required in case of hideExisting is set to true.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors/{databaseConnectorId}/fetch?hideExisting=true&rulesetId=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "string"
]

Get supported connection properties for database connector by ID

Request

A list of connection properties supported by the database connector's underlying JDBC driver.

Security
api_key
Path
databaseConnectorIdinteger(int32)required

The ID of the database connector to retrieve supported connection properties

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors/{databaseConnectorId}/properties' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ConnectionProperties)
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Test database connector by ID

Request

Test if a database connector is valid.

Security
api_key
Path
databaseConnectorIdinteger(int32)required

The ID of the database connector to test

Bodyapplication/json

The database connector configuration to test. This field is optional. If null or empty, the existing databaseConnectorId will be tested. If a connector configuration is supplied without a password, then the password associated with the databaseConnectorId will be used.

connectorNamestring<= 255 characters

The name of the connector.

Example: "Con123"
databaseTypestring

The type of database the connector will connect to.

Enum"AURORA_POSTGRES""DB2""DB2_ISERIES""DB2_MAINFRAME""EXTENDED""GENERIC""MARIADB""MSSQL""MYSQL""ORACLE"
Example: "ORACLE"
environmentIdinteger(int32)

The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.

Example: 1
customDriverNamestring<= 255 characters

The name of the custom driver to use. Only used for database type 'GENERIC'.

databaseNamestring<= 255 characters

The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

hoststring<= 500 characters

The host name or IP address where the database is located.

Example: "europa.delphix.com"
instanceNamestring<= 50 characters

The name of the database instance. Only used for database type 'MSSQL'.

jdbcstring

The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.

passwordstring<= 255 characters

The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Pass_123"
portinteger[ 0 .. 65535 ]

The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.

Example: 1521
schemaNamestring<= 255 characters

The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.

Example: "MASKER"
sidstring<= 255 characters

The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.

Example: "TEST"
usernamestring<= 255 characters

The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.

Example: "MASKER"
kerberosAuthboolean

Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance

Default false
servicePrincipalstring<= 256 characters

The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

jdbcDriverIdinteger(int32)

The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

enableLoggerboolean

Whether to enable the logger. This is exclusively used for extended connectors.

fileReferenceIdstring

The reference to the uploaded connection property file.

credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors/{databaseConnectorId}/test' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "Con123",
    "databaseType": "ORACLE",
    "environmentId": 1,
    "host": "europa.delphix.com",
    "password": "Pass_123",
    "port": 1521,
    "schemaName": "MASKER",
    "sid": "TEST",
    "username": "MASKER"
  }'

Responses

Success

Bodyapplication/json
responsestring

Success or failure of the connection test.

Response
application/json
{
  "response": "string"
}

Test an unsaved database connector

Request

Security
api_key
Bodyapplication/jsonrequired

The database connector to test

connectorNamestring<= 255 characters

The name of the connector.

Example: "Con123"
databaseTypestring

The type of database the connector will connect to.

Enum"AURORA_POSTGRES""DB2""DB2_ISERIES""DB2_MAINFRAME""EXTENDED""GENERIC""MARIADB""MSSQL""MYSQL""ORACLE"
Example: "ORACLE"
environmentIdinteger(int32)

The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.

Example: 1
customDriverNamestring<= 255 characters

The name of the custom driver to use. Only used for database type 'GENERIC'.

databaseNamestring<= 255 characters

The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

hoststring<= 500 characters

The host name or IP address where the database is located.

Example: "europa.delphix.com"
instanceNamestring<= 50 characters

The name of the database instance. Only used for database type 'MSSQL'.

jdbcstring

The jdbc connection string. This can be used as an alternative to specifying a 'host', 'databaseName', 'SID', and 'port'. This value is only applicable when using database types 'ORACLE', 'MSSQL', 'SYBASE', 'EXTENDED' and 'GENERIC'.

passwordstring<= 255 characters

The password required to access the database. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Pass_123"
portinteger[ 0 .. 65535 ]

The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.

Example: 1521
schemaNamestring<= 255 characters

The schema name on the database. Note that this field should be uppercase for database type 'ORACLE'. Also note that this field is not relevant for database type 'MYSQL'.

Example: "MASKER"
sidstring<= 255 characters

The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.

Example: "TEST"
usernamestring<= 255 characters

The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.

Example: "MASKER"
kerberosAuthboolean

Whether to use kerberos to authenticate database connections. When kerberosAuth is enabled, the username field is treated as the kerberos principal. Kerberos must be enabled on the appliance

Default false
servicePrincipalstring<= 256 characters

The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

jdbcDriverIdinteger(int32)

The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

enableLoggerboolean

Whether to enable the logger. This is exclusively used for extended connectors.

fileReferenceIdstring

The reference to the uploaded connection property file.

credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-connectors/test \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "Con123",
    "databaseType": "ORACLE",
    "environmentId": 1,
    "host": "europa.delphix.com",
    "password": "Pass_123",
    "port": 1521,
    "schemaName": "MASKER",
    "sid": "TEST",
    "username": "MASKER"
  }'

Responses

Success

Bodyapplication/json
responsestring

Success or failure of the connection test.

Response
application/json
{
  "response": "string"
}

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

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