databaseConnector

Get all database connectors

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get database connectors. This will default to the first page if excluded

page_size
integer <int64>

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

environment_id
integer <int32>

The ID of the environment to get all database connectors from

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/database-connectors
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create database connector

Securityapi_key
Request
Request Body schema: application/json
required

The database connector to create

connectorName
string <= 255 characters

The name of the connector.

databaseType
string

The type of database the connector will connect to.

Enum: "AURORA_POSTGRES" "DB2" "DB2_ISERIES" "DB2_MAINFRAME" "EXTENDED" "GENERIC" "MARIADB" "MSSQL" "MYSQL" "ORACLE" "POSTGRES" "RDS_POSTGRES" "SYBASE" "YUGABYTEDB_POSTGRES" "COCKROACHDB_POSTGRES"
environmentId
integer <int32>

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

customDriverName
string <= 255 characters

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

databaseName
string <= 255 characters

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

host
string <= 500 characters

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

instanceName
string <= 50 characters

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

jdbc
string

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'.

password
string <= 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.

port
integer [ 0 .. 65535 ]

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

schemaName
string <= 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'.

sid
string <= 255 characters

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

username
string <= 255 characters

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

kerberosAuth
boolean
Default: false

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

servicePrincipal
string <= 256 characters

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

jdbcDriverId
integer <int32>

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

enableLogger
boolean

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

fileReferenceId
string

The reference to the uploaded connection property file.

credentialPathId
integer <int32>

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

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

post/database-connectors
Request samples
application/json
{
  • "connectorName": "Con123",
  • "databaseType": "ORACLE",
  • "environmentId": 1,
  • "host": "europa.delphix.com",
  • "password": "Pass_123",
  • "port": 1521,
  • "schemaName": "MASKER",
  • "sid": "TEST",
  • "username": "MASKER"
}
Response samples
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

Securityapi_key
Request
path Parameters
databaseConnectorId
required
integer <int32>

The ID of the database connector to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/database-connectors/{databaseConnectorId}
Response samples
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

Securityapi_key
Request
path Parameters
databaseConnectorId
required
integer <int32>

The ID of the database connector to update

Request Body schema: application/json
required

The updated database connector

connectorName
string <= 255 characters

The name of the connector.

databaseType
string

The type of database the connector will connect to.

Enum: "AURORA_POSTGRES" "DB2" "DB2_ISERIES" "DB2_MAINFRAME" "EXTENDED" "GENERIC" "MARIADB" "MSSQL" "MYSQL" "ORACLE" "POSTGRES" "RDS_POSTGRES" "SYBASE" "YUGABYTEDB_POSTGRES" "COCKROACHDB_POSTGRES"
environmentId
integer <int32>

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

customDriverName
string <= 255 characters

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

databaseName
string <= 255 characters

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

host
string <= 500 characters

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

instanceName
string <= 50 characters

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

jdbc
string

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'.

password
string <= 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.

port
integer [ 0 .. 65535 ]

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

schemaName
string <= 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'.

sid
string <= 255 characters

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

username
string <= 255 characters

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

kerberosAuth
boolean
Default: false

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

servicePrincipal
string <= 256 characters

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

jdbcDriverId
integer <int32>

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

enableLogger
boolean

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

fileReferenceId
string

The reference to the uploaded connection property file.

credentialPathId
integer <int32>

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

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/database-connectors/{databaseConnectorId}
Request samples
application/json
{
  • "connectorName": "Con123",
  • "databaseType": "ORACLE",
  • "environmentId": 1,
  • "host": "europa.delphix.com",
  • "password": "Pass_123",
  • "port": 1521,
  • "schemaName": "MASKER",
  • "sid": "TEST",
  • "username": "MASKER"
}
Response samples
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

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

Securityapi_key
Request
path Parameters
databaseConnectorId
required
integer <int32>

The ID of the database connector to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/database-connectors/{databaseConnectorId}

Fetch all accessible table names

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

Securityapi_key
Request
path Parameters
databaseConnectorId
required
integer <int32>

The ID of the database connector to fetch the tables for

query Parameters
hideExisting
boolean

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

rulesetId
integer <int32>

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

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/database-connectors/{databaseConnectorId}/fetch
Response samples
application/json
[
  • "string"
]

Get supported connection properties for database connector by ID

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

Securityapi_key
Request
path Parameters
databaseConnectorId
required
integer <int32>

The ID of the database connector to retrieve supported connection properties

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/database-connectors/{databaseConnectorId}/properties
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Test database connector by ID

Test if a database connector is valid.

Securityapi_key
Request
path Parameters
databaseConnectorId
required
integer <int32>

The ID of the database connector to test

Request Body schema: application/json
optional

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.

connectorName
string <= 255 characters

The name of the connector.

databaseType
string

The type of database the connector will connect to.

Enum: "AURORA_POSTGRES" "DB2" "DB2_ISERIES" "DB2_MAINFRAME" "EXTENDED" "GENERIC" "MARIADB" "MSSQL" "MYSQL" "ORACLE" "POSTGRES" "RDS_POSTGRES" "SYBASE" "YUGABYTEDB_POSTGRES" "COCKROACHDB_POSTGRES"
environmentId
integer <int32>

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

customDriverName
string <= 255 characters

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

databaseName
string <= 255 characters

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

host
string <= 500 characters

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

instanceName
string <= 50 characters

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

jdbc
string

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'.

password
string <= 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.

port
integer [ 0 .. 65535 ]

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

schemaName
string <= 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'.

sid
string <= 255 characters

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

username
string <= 255 characters

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

kerberosAuth
boolean
Default: false

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

servicePrincipal
string <= 256 characters

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

jdbcDriverId
integer <int32>

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

enableLogger
boolean

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

fileReferenceId
string

The reference to the uploaded connection property file.

credentialPathId
integer <int32>

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

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/database-connectors/{databaseConnectorId}/test
Request samples
application/json
{
  • "connectorName": "Con123",
  • "databaseType": "ORACLE",
  • "environmentId": 1,
  • "host": "europa.delphix.com",
  • "password": "Pass_123",
  • "port": 1521,
  • "schemaName": "MASKER",
  • "sid": "TEST",
  • "username": "MASKER"
}
Response samples
application/json
{
  • "response": "string"
}

Test an unsaved database connector

Securityapi_key
Request
Request Body schema: application/json
required

The database connector to test

connectorName
string <= 255 characters

The name of the connector.

databaseType
string

The type of database the connector will connect to.

Enum: "AURORA_POSTGRES" "DB2" "DB2_ISERIES" "DB2_MAINFRAME" "EXTENDED" "GENERIC" "MARIADB" "MSSQL" "MYSQL" "ORACLE" "POSTGRES" "RDS_POSTGRES" "SYBASE" "YUGABYTEDB_POSTGRES" "COCKROACHDB_POSTGRES"
environmentId
integer <int32>

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

customDriverName
string <= 255 characters

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

databaseName
string <= 255 characters

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

host
string <= 500 characters

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

instanceName
string <= 50 characters

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

jdbc
string

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'.

password
string <= 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.

port
integer [ 0 .. 65535 ]

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

schemaName
string <= 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'.

sid
string <= 255 characters

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

username
string <= 255 characters

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

kerberosAuth
boolean
Default: false

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

servicePrincipal
string <= 256 characters

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

jdbcDriverId
integer <int32>

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

enableLogger
boolean

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

fileReferenceId
string

The reference to the uploaded connection property file.

credentialPathId
integer <int32>

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

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/database-connectors/test
Request samples
application/json
{
  • "connectorName": "Con123",
  • "databaseType": "ORACLE",
  • "environmentId": 1,
  • "host": "europa.delphix.com",
  • "password": "Pass_123",
  • "port": 1521,
  • "schemaName": "MASKER",
  • "sid": "TEST",
  • "username": "MASKER"
}
Response samples
application/json
{
  • "response": "string"
}
➔ Next to databaseRuleset