# Update database connector by ID

Endpoint: PUT /database-connectors/{databaseConnectorId}
Version: 5.1.45
Security: api_key

## Path parameters:

  - `databaseConnectorId` (integer, required)
    The ID of the database connector to update

## Request fields (application/json):

  - `connectorName` (string)
    The name of the connector.
    Example: "Con123"

  - `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)
    The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.
    Example: 1

  - `customDriverName` (string)
    The name of the custom driver to use. Only used for database type 'GENERIC'.

  - `databaseName` (string)
    The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

  - `host` (string)
    The host name or IP address where the database is located.
    Example: "europa.delphix.com"

  - `instanceName` (string)
    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)
    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"

  - `port` (integer)
    The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.
    Example: 1521

  - `schemaName` (string)
    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"

  - `sid` (string)
    The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.
    Example: "TEST"

  - `username` (string)
    The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.
    Example: "MASKER"

  - `kerberosAuth` (boolean)
    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)
    The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

  - `jdbcDriverId` (integer)
    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)
    The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

## Response 200 fields (application/json):

  - `databaseConnectorId` (integer)
    The ID number of the connector. This field is auto-generated by the Masking Engine.

  - `connectorName` (string)
    The name of the connector.
    Example: "Con123"

  - `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)
    The ID of the environment under which to create the connector. Once the connector is created, this value cannot be changed.
    Example: 1

  - `customDriverName` (string)
    The name of the custom driver to use. Only used for database type 'GENERIC'.

  - `databaseName` (string)
    The name of the database to connect to. This field is not valid for database types 'ORACLE' and 'GENERIC'.

  - `host` (string)
    The host name or IP address where the database is located.
    Example: "europa.delphix.com"

  - `instanceName` (string)
    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)
    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"

  - `port` (integer)
    The port to use for connecting to the database. This field is not valid for the database type 'GENERIC'.
    Example: 1521

  - `schemaName` (string)
    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"

  - `sid` (string)
    The SID of the Oracle Instance to connect to. This field is only valid for database type 'ORACLE'.
    Example: "TEST"

  - `username` (string)
    The username required to access the database. Note that this field should be uppercase for database type 'ORACLE'.
    Example: "MASKER"

  - `kerberosAuth` (boolean)
    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)
    The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

  - `jdbcDriverId` (integer)
    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.

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

  - `credentialPathId` (integer)
    The ID of the credential path to use for this connector. Used to retrieve database login credentials from a password vault.

  - `authPresent` (string)
    Denotes whether authentication is present or not for this connector, UI only field


## Response 400 fields

## Response 403 fields

## Response 404 fields