1Get Advanced Properties
Overview
This API retrieves all the advanced properties applicable to a Connection.
Method: GET
Request URL: {kyvos-url}/rest/v2/connections/{connection-name}/advance-properties
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
connection-name (Required) | String | Name of the Connection whose advanced properties need to be retrieved. | – |
Responses
200 Success
{
"advanceProperties":[
{
"name":"role",
"full_name":"Role",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"db",
"full_name":"Database",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"schema",
"full_name":"Schema",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"warehouse",
"full_name":"Warehouse",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"private_key_file",
"full_name":"Private Key File",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"private_key_file_pwd",
"full_name":"Private Key_File_Pwd",
"type":"password",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"loginTimeout",
"full_name":"LoginTimeout",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"networkTimeout",
"full_name":"NetworkTimeout",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"queryTimeout",
"full_name":"QueryTimeout",
"type":"textbox",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"passcode",
"full_name":"Passcode",
"type":"password",
"sub_type":"",
"default_val":"",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"passcodeInPassword",
"full_name":"passcodeInPassword",
"type":"combo",
"sub_type":"single-select",
"predefined_vals":[
{
"actualValue":"true",
"displayValue":true
},
{
"actualValue":"false",
"displayValue":false
}
],
"default_val":"false",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"tracing",
"full_name":"tracing",
"type":"combo",
"sub_type":"single-select",
"predefined_vals":[
{
"actualValue":"OFF",
"displayValue":"OFF"
},
{
"actualValue":"SEVERE",
"displayValue":"SEVERE"
},
{
"actualValue":"WARNING",
"displayValue":"WARNING"
},
{
"actualValue":"INFO",
"displayValue":"INFO"
},
{
"actualValue":"CONFIG",
"displayValue":"CONFIG"
},
{
"actualValue":"FINE",
"displayValue":"FINE"
},
{
"actualValue":"FINER",
"displayValue":"FINER"
},
{
"actualValue":"FINEST",
"displayValue":"FINEST"
},
{
"actualValue":"ALL",
"displayValue":"ALL"
}
],
"default_val":"INFO",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"disableSocksProxy",
"full_name":"DisableSocksProxy",
"type":"combo",
"sub_type":"single-select",
"predefined_vals":[
{
"actualValue":"true",
"displayValue":true
},
{
"actualValue":"false",
"displayValue":false
}
],
"default_val":"false",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
},
{
"name":"CLIENT_SESSION_KEEP_ALIVE",
"full_name":"Client Session Keep Alive",
"type":"combo",
"sub_type":"single-select",
"predefined_vals":[
{
"actualValue":"true",
"displayValue":true
},
{
"actualValue":"false",
"displayValue":false
}
],
"default_val":"false",
"note":"",
"keywords":"",
"group":"snowflake",
"parentGroup":"snowflake",
"description":""
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
500 | Internal Server Error. |