Administrator
- Administrator
- All Products
Attribute
| Description
|
---|---|
id
| Connection ID.
|
orgId
| Organization ID.
|
name
| Connection name.
|
description
| Optional connection description.
|
type
| Connection type. Use one of the following codes:
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.
|
authenticationType
| Authentication method for the connection. Use one of the following options:
|
username
| User name for the database login. Use when authenticationType is SqlServer.
|
password
| Password for the database login. Use when authenticationType is SqlServer.
|
host
| Name of the machine hosting the database server.
|
port
| Network port number used to connect to the database server. Default port number is 1433.
|
instanceName
| Instance name of the Microsoft SQL Server database.
|
database
| Database 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.
|
schema
| Schema used for the target connection.
|
codepage
| The code page of the Microsoft SQL Server database. Use one of the following options:
|
agentId
| Secure Agent ID.
|