Get Environment Using GET

Get Environment Using GET

Retrieves the environment settings.

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

OK

Returns EnvironmentInfo of type(s) */* 
{
    "cluster_guid": "d0325b13-2bf1-4fa4-b027-e780004f2d1e",
    "cluster_name": "master-cluster",
    "fips_mode_enabled": false,
    "ip_mode": "IPv4",
    "local_pod_name": "master-pod",
    "timezone_offset": 19800
}
string
cluster_guid
Required

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

string
cluster_name
Required

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

boolean
fips_mode_enabled
Required

Indicates if FIPS mode is enabled.

string
ip_mode
Required

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_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
Required

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 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
DELETE
Delete IC Domain Account
DELETE
Delete IM Asset
DELETE
Delete IM Stream
DELETE
Delete IM Tag
DELETE
Delete IM Version
GET
Get Environment Using GET
GET
Get Feature Settings Using GET
GET
Get General Settings Using GET
GET
Get IC Domain Account
GET
Get IM Asset
GET
Get IM Stream
GET
Get IM Tag
GET
Get IM Version
GET
Get Security Settings Using GET
GET
Get Settings Using GET
GET
List IC Domain Accounts
GET
List IM Assets
GET
List IM Streams
GET
List IM Tags
GET
List IM Versions
GET
List RCX Servers
GET
List VC Info
POST
Register RCX Client
DELETE
Unregister RCX Client
PUT
Update Feature Settings Using PUT
PUT
Update General Settings Using PUT
PUT
Update IC Domain Account
PUT
Update IM Asset
PUT
Update IM Stream
PUT
Update IM Tag
PUT
Update IM Version
PUT
Update RCX Client
PUT
Update Security Settings Using PUT
PUT
Update Settings Using PUT