Skip to main content
URL: http://<db.host>:<db.port>/show/environment
Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.

​
Input Parameter Description

​
environment_name
string
Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If ’*’ or an empty value is specified, information about all environments will be returned.The default value is ”.
​
options
map of string to strings
Optional parameters.The default value is an empty map ( {} ).

​
Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
​
status
String
‘OK’ or ‘ERROR’
​
message
String
Empty if success or an error message
​
data_type
String
‘show_environment_response’ or ‘none’ in case of an error
​
data
String
Empty string
​
data_str
JSON or String
This embedded JSON represents the result of the /show/environment endpoint:Empty string in case of an error.