Get Environment V2

Get Environment V2

Retrieves the environment settings.

Request
URI
GET
https://{api_host}//localhost/rest/config/v2/environment-properties
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EnvironmentInfoV2 of type(s) */* 
{
    "cluster_guid": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
    "cluster_name": "master-cluster",
    "deployment_type": "string",
    "fips_mode_enabled": false,
    "ip_mode": "IPv4",
    "local_connection_server_build": 12345678,
    "local_connection_server_version": "8.1.0",
    "local_pod_name": "master-pod",
    "timezone_offset": 19800
}
string
cluster_guid
Optional

The GUID of a group of Connection Servers sharing the same configuration.

string
cluster_name
Optional

The name of a group of Connection Servers sharing the same configuration.

string
deployment_type
Optional

Indicates different environments that Horizon can be deployed into.

  • GENERAL: Horizon is deployed on On-premises.
  • AZURE: Horizon is deployed on Azure.
  • AWS: Horizon is deployed on AWS.
  • DELL_EMC: Horizon is deployed on Dell EMC.
  • GOOGLE: Horizon is deployed on Google Cloud.
  • ORACLE: Horizon is deployed on Oracle Cloud.
Possible values are : GENERAL, AZURE, AWS, DELL_EMC, GOOGLE, ORACLE,
boolean
fips_mode_enabled
Optional

Indicates if FIPS mode is enabled.

string
ip_mode
Optional

Indicates the IP mode of the environment.

  • IPv4: The ip mode is IPv4.
  • IPv6: The ip mode is IPv6.
Possible values are : IPv4, IPv6,
string
local_connection_server_build
Optional

Local connection Server build number.

string
local_connection_server_version
Optional

Local connection Server version number.

string
local_pod_name
Optional

The name of the current pod in the Multi-DataCenter Horizon Pod, the value will be null when PodFederation is not initialized.

integer As int32 As int32
timezone_offset
Optional

Represents the clusters time zone offset from UTC in seconds.


401

User is not authenticated

Operation doesn't return any data structure

On This Page
Config Operations
POST
Create Federation Access Group
POST
Create IC Domain Account
POST
Create IM Asset
POST
Create IM Assets
POST
Create IM Stream
POST
Create IM Streams
POST
Create IM Tag
POST
Create IM Tags
POST
Create IM Version
POST
Create IM Versions
POST
Create JWT Authenticator
POST
Create Local Access Group
POST
Create Permissions
POST
Create Role
DELETE
Delete Federation Access Group
DELETE
Delete IC Domain Account
DELETE
Delete IM Asset
DELETE
Delete IM Stream
DELETE
Delete IM Tag
DELETE
Delete IM Version
DELETE
Delete JWT Authenticator
DELETE
Delete Local Access Group
DELETE
Delete Permissions
DELETE
Delete Role
GET
Get Connection Server
GET
Get Environment
GET
Get Environment V2
GET
Get Feature Settings
GET
Get Federation Access Group
GET
Get Federation Access Group V2
GET
Get General Settings
GET
Get General Settings V2
GET
Get IC Domain Account
GET
Get IM Asset
GET
Get IM Stream
GET
Get IM Tag
GET
Get IM Version
GET
Get JWT Authenticator
GET
Get Local Access Group
GET
Get Local Access Group V2
GET
Get Permission
GET
Get Role
GET
Get Security Settings
GET
Get Settings
GET
Get Settings V2
GET
List Connection Servers
GET
List Federation Access Groups
GET
List Federation Access Groups V2
GET
List IC Domain Accounts
GET
List IM Assets
GET
List IM Streams
GET
List IM Tags
GET
List IM Versions
GET
List JWT Authenticators
GET
List Local Access Groups
GET
List Local Access Groups V2
GET
List Permissions
GET
List RCX Servers
GET
List Roles
GET
List Selectable Privileges
GET
List VC Info
GET
List VC Info V2
POST
Mark Datastores For Archival
POST
Register RCX Client
DELETE
Unregister RCX Client
PUT
Update Connection Server
PUT
Update Feature Settings
PUT
Update General Settings
PUT
Update General Settings V2
PUT
Update IC Domain Account
PUT
Update IM Asset
PUT
Update IM Stream
PUT
Update IM Tag
PUT
Update IM Version
PUT
Update JWT Authenticator
PUT
Update RCX Client
PUT
Update Role
PUT
Update Security Settings
PUT
Update Settings
PUT
Update Settings V2