• Home
  • Dynatrace Managed
  • Cluster API
  • Cluster API v2
  • Activegates
  • Get Cluster ActiveGate details

Get Cluster ActiveGate details

Gets details about the specified ActiveGate.

The request produces an application/json payload.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/cluster/v2/activeGates/{agId}

ActiveGate ID conversion

The ID returned for the Cluster ActiveGate v2 endpoint is a hexadecimal representation of the node ID. If you want to use the ID in other endpoints that require the entity ID—for example, v1 endpoints with /api/v1.0/onpremise/sslCertificate—you need to convert it to the decimal representation of the entity ID.

Parameters

ParameterTypeDescriptionInRequired
agIdstring

The ID of the required ActiveGate.

pathrequired

Response

Response codes

CodeTypeDescription
200ActiveGate

Success

404ErrorEnvelope

Not found. See response body for details.

Response body objects

The ActiveGate object

Parameters of the ActiveGate.

ElementTypeDescription
idstring

The ID of the ActiveGate.

networkAddressesstring[]

A list of network addresses of the ActiveGate.

loadBalancerAddressesstring[]

A list of Load Balancer addresses of the ActiveGate.

osTypestring

The OS type that the ActiveGate is running on.

The element can hold these values
  • LINUX
  • WINDOWS
autoUpdateStatusstring

The current status of auto-updates of the ActiveGate.

The element can hold these values
  • INCOMPATIBLE
  • OUTDATED
  • SCHEDULED
  • SUPPRESSED
  • UNKNOWN
  • UP2DATE
  • UPDATE_IN_PROGRESS
  • UPDATE_PENDING
  • UPDATE_PROBLEM
offlineSinceinteger

The timestamp since when the ActiveGate is offline.

The null value means the ActiveGate is online.

versionstring

The current version of the ActiveGate in the <major>.<minor>.<revision>.<timestamp> format.

typestring

The type of the ActiveGate.

The element can hold these values
  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI
hostnamestring

The name of the host the ActiveGate is running on.

mainEnvironmentstring

The ID of the main environment for a multi-environment ActiveGate.

environmentsstring[]

A list of environments (specified by IDs) the ActiveGate can connect to.

autoUpdateSettingsActiveGateAutoUpdateConfig

Configuration of the ActiveGate auto-updates.

networkZonestring

The network zone of the ActiveGate.

groupstring

The group of the ActiveGate.

modulesActiveGateModule[]

A list of modules of the ActiveGate.

containerizedboolean

ActiveGate is deployed in container (true) or not (false).

connectedHostsActiveGateConnectedHosts

Information about hosts currently connected to the ActiveGate

The ActiveGateAutoUpdateConfig object

Configuration of the ActiveGate auto-updates.

ElementTypeDescription
settingstring

The state of the ActiveGate auto-update: enabled, disabled, or inherited.

If set to INHERITED, the setting is inherited from the global configuration set on the environment or Managed cluster level.

The element can hold these values
  • DISABLED
  • ENABLED
  • INHERITED
effectiveSettingstring

The actual state of the ActiveGate auto-update.

Applicable only if the setting parameter is set to INHERITED. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the setting value.

The element can hold these values
  • ENABLED
  • DISABLED

The ActiveGateModule object

Information about ActiveGate module

ElementTypeDescription
misconfiguredboolean

The module is misconfigured (true) or not (false).

versionstring

The version of the ActiveGate module.

typestring

The type of ActiveGate module.

The element can hold these values
  • AWS
  • AZURE
  • BEACON_FORWARDER
  • CLOUD_FOUNDRY
  • DB_INSIGHT
  • EXTENSIONS_V1
  • EXTENSIONS_V2
  • KUBERNETES
  • LOGS
  • MEMORY_DUMPS
  • METRIC_API
  • ONE_AGENT_ROUTING
  • OTLP_INGEST
  • REST_API
  • SYNTHETIC
  • VMWARE
  • Z_OS
attributesobject

The attributes of the ActiveGate module.

enabledboolean

The module is enabled (true) or disabled (false).

The ActiveGateConnectedHosts object

Information about hosts currently connected to the ActiveGate

ElementTypeDescription
numberinteger

The number of hosts currently connected to the ActiveGate

Response body JSON model

json
{ "id": "0x3efdd091", "networkAddresses": [ "string" ], "loadBalancerAddresses": [ "string" ], "osType": "WINDOWS", "autoUpdateStatus": "OUTDATED", "offlineSince": 1582031917814, "version": "1.185.0.20200201-120000", "type": "ENVIRONMENT", "hostname": "exampleHostname", "mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f", "environments": [ "string" ], "autoUpdateSettings": { "setting": "INHERITED", "effectiveSetting": "ENABLED" }, "networkZone": "exampleNetworkZone", "group": "default", "modules": [ { "misconfigured": true, "version": "string", "type": "KUBERNETES", "attributes": {}, "enabled": true } ], "containerized": true, "connectedHosts": { "number": 150 } }

Example

In this example, the request lists the parameters of the ActiveGate with the ID of 876651882.

The API token is passed in the Authorization header.

Curl

bash
curl -L -X GET 'https://myManaged.cluster.com/api/cluster/v2/activeGates/876651882' \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://myManaged.cluster.com/api/cluster/v2/activeGates/876651882

Response body

json
{ "id": "876651882", "networkAddresses": [ "orange-13.easytravel.com", "228.245.125.39" ], "osType": "LINUX", "autoUpdateStatus": "UPDATE_IN_PROGRESS", "offlineSince": null, "version": "1.198.0.20200630-163221", "type": "ENVIRONMENT", "hostname": "orange-13.easytravel.com", "mainEnvironment": null, "environments": [ "mySampleEnv" ], "networkZone": "easytravel.europe.austria.05" }

Response code

200