# Get all database connectors

Endpoint: GET /database-connectors
Version: 5.1.45
Security: api_key

## Query parameters:

  - `page_number` (integer)
    The page number for which to get database connectors. This will default to the first page if excluded

  - `page_size` (integer)
    The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

  - `environment_id` (integer)
    The ID of the environment to get all database connectors from

## Response 200 fields (application/json):

  - `_pageInfo` (object)

  - `_pageInfo.numberOnPage` (integer)
    The number of items on this page. This should always match the page size unless it is the last page.

  - `_pageInfo.total` (integer)
    The total number of items

  - `responseList` (array)
    Example: [{"connectorName":"Con123","databaseType":"ORACLE","environmentId":1,"host":"europa.delphix.com","password":"Pass_123","port":1521,"schemaName":"MASKER","sid":"TEST","username":"MASKER"}]

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

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

  - `responseList.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"

  - `responseList.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

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

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

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

  - `responseList.instanceName` (string)
    The name of the database instance. Only used for database type 'MSSQL'.

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

  - `responseList.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"

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

  - `responseList.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"

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

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

  - `responseList.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

  - `responseList.servicePrincipal` (string)
    The service principal used to access the database. This property is exclusive to Sybase connectors using Kerberos.

  - `responseList.jdbcDriverId` (integer)
    The ID of the JDBC driver to use for this connector. This is exclusively used for extended connectors.

  - `responseList.enableLogger` (boolean)
    Whether to enable the logger. This is exclusively used for extended connectors.

  - `responseList.fileReferenceId` (string)
    The reference to the uploaded connection property file.

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

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

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


## Response 400 fields

## Response 403 fields

## Response 404 fields