Microsoft SQL Server Connections

When you create or update a Microsoft SQL Server connection, you can configure additional attributes, such as the connection ID and the connection name.

The following table describes attributes that you can use for Microsoft SQL Server connections:

AttributeDescription
idConnection ID
orgidOrganization ID.
nameConnection name.
descriptionOptional connection description.
typeConnection type. Use one of the following codes:
SqlServer. Microsoft SQL Server 2000.
SqlServer2005. Microsoft SQL Server 2005.
SqlServer2008. Microsoft SQL Server 2008.
SqlServer2012. Microsoft SQL Server 2012.
In the user interface, this attribute is the SQL Server Version field. In the REST API response that populates the value in the user interface, the name of this attribute is subType
usernameUser name for the database login. Use when authenticationType is SqlServer.
passwordPassword for the database login. Use when authenticationType is SqlServer.
hostName of the machine hosting the database server.
portNetwork port number used to connect to the database server. Default port number is 1433.
instaceNameInstance name of the Microsoft SQL Server database.
databaseDatabase name for the Microsoft SQL Server target. Database name is case sensitive if the database is case sensitive. Maximum length is 100 characters.
Database names can include alphanumeric and underscore characters.
schemaSchema used for the target connection.
codepageThe code page of the Microsoft SQL Server database. Use one of the following options:
UTF-8. Unicode Transformation Format, multibyte.
MS1252. MS Windows Latin 1 (ANSI), superset of Latin 1.
ISO-8859-15. Latin 9, Western European.
ISO-8859-2. Eastern European.
ISO-8859-3. Southeast European.
ISO-8859-5. Cyrillic.
ISO-8859-9. Latin 5, Turkish.
IBM500. IBM EBCDIC International Latin-1.
agentidSecure Agent ID