List Cluster ActiveGates
Lists all available ActiveGates.
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
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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
hostname | string | Filters the resulting set of ActiveGates by the name of the host it's running on. You can specify a partial name. In that case, the | query | optional |
osType | string | Filters the resulting set of ActiveGates by the OS type of the host it's running on.
| query | optional |
networkAddress | string | Filters the resulting set of ActiveGates by the network address. You can specify a partial address. In that case, the | query | optional |
loadBalancerAddress | string | Filters the resulting set of ActiveGates by the Load Balancer address. You can specify a partial address. In that case, the | query | optional |
type | string | Filters the resulting set of ActiveGates by the ActiveGate type.
| query | optional |
networkZone | string | Filters the resulting set of ActiveGates by the network zone. You can specify a partial name. In that case, the | query | optional |
updateStatus | string | Filters the resulting set of ActiveGates by the auto-update status.
| query | optional |
versionCompareType | string | Filters the resulting set of ActiveGates by the specified version. Specify the comparison operator here.
| query | optional |
version | string | Filters the resulting set of ActiveGates by the specified version. Specify the version in | query | optional |
autoUpdate | string | Filters the resulting set of ActiveGates by the actual state of auto-update.
| query | optional |
group | string | Filters the resulting set of ActiveGates by the group. You can specify a partial name. In that case, the | query | optional |
online | boolean | Filters the resulting set of ActiveGates by the communication status. | query | optional |
enabledModule | string[] | Filters the resulting set of ActiveGates by the enabled modules.
| query | optional |
disabledModule | string[] | Filters the resulting set of ActiveGates by the disabled modules.
| query | optional |
containerized | boolean | Filters the resulting set of ActiveGates to those which are running in container ( | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Active | Success |
400 | Error | Failed. The input is invalid. |
Response body objects
The ActiveGateList
object
A list of ActiveGates.
Element | Type | Description |
---|---|---|
activeGates | Active | A list of ActiveGates. |
The ActiveGate
object
Parameters of the ActiveGate.
Element | Type | Description |
---|---|---|
id | string | The ID of the ActiveGate. |
networkAddresses | string[] | A list of network addresses of the ActiveGate. |
loadBalancerAddresses | string[] | A list of Load Balancer addresses of the ActiveGate. |
osType | string | The OS type that the ActiveGate is running on.
|
autoUpdateStatus | string | The current status of auto-updates of the ActiveGate.
|
offlineSince | integer | The timestamp since when the ActiveGate is offline. The |
version | string | The current version of the ActiveGate in the |
type | string | The type of the ActiveGate.
|
hostname | string | The name of the host the ActiveGate is running on. |
mainEnvironment | string | The ID of the main environment for a multi-environment ActiveGate. |
environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. |
autoUpdateSettings | Active | Configuration of the ActiveGate auto-updates. |
networkZone | string | The network zone of the ActiveGate. |
group | string | The group of the ActiveGate. |
modules | Active | A list of modules of the ActiveGate. |
containerized | boolean | ActiveGate is deployed in container ( |
connectedHosts | Active | Information about hosts currently connected to the ActiveGate |
The ActiveGateAutoUpdateConfig
object
Configuration of the ActiveGate auto-updates.
Element | Type | Description |
---|---|---|
setting | string | The state of the ActiveGate auto-update: enabled, disabled, or inherited. If set to
|
effectiveSetting | string | The actual state of the ActiveGate auto-update. Applicable only if the setting parameter is set to
|
The ActiveGateModule
object
Information about ActiveGate module
Element | Type | Description |
---|---|---|
misconfigured | boolean | The module is misconfigured ( |
version | string | The version of the ActiveGate module. |
type | string | The type of ActiveGate module.
|
attributes | object | The attributes of the ActiveGate module. |
enabled | boolean | The module is enabled ( |
The ActiveGateConnectedHosts
object
Information about hosts currently connected to the ActiveGate
Element | Type | Description |
---|---|---|
number | integer | The number of hosts currently connected to the ActiveGate |
Response body JSON model
{"activeGates": [{"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 all available ActiveGates.
The API token is passed in the Authorization header.
Curl
curl -X GET "https://latest.managed-dev.dynalabs.io/api/cluster/v2/activeGates?versionCompareType=EQUAL" -H "accept: application/json; charset=utf-8" -H "Authorization: Api-Token dt0c01.123245ABC6XYZ12345ABCEFG.ABCDEFGHIFONYABCWKIHM6HDNWP4QK2EOABC6EDEF6HIJ3C33CUBTABC64ABC"
Request URL
https://myManaged.cluster.com/api/cluster/v2/activeGates?versionCompareType=EQUAL
Response body
{"activeGates": [{"id": "0x12f7f345","networkAddresses": ["10.0.2.15"],"loadBalancerAddresses": [],"osType": "LINUX","osArchitecture": "X86","osBitness": "64","autoUpdateStatus": "OUTDATED","offlineSince": 1656926608637,"version": "1.242.0.20220506-012008","type": "ENVIRONMENT","hostname": "10.0.3.14","mainEnvironment": null,"environments": [],"autoUpdateSettings": {"setting": "INHERITED","effectiveSetting": "DISABLED"},"networkZone": "aistitenantzone","group": "default","modules": [],"containerized": false,"connectedHosts": {"number": 0},"activeGateTokens": []},{"id": "0xe12f4b4e","networkAddresses": ["abc.efg-hij.org","172.18.149.164"],"loadBalancerAddresses": ["172.18.149.164"],"osType": "LINUX","osArchitecture": "X86","osBitness": "64","autoUpdateStatus": "UP2DATE","offlineSince": null,"version": "1.247.0.20220707-181710","type": "CLUSTER","hostname": "abc.efg-hij.org","mainEnvironment": null,"environments": [],"autoUpdateSettings": {"setting": "ENABLED","effectiveSetting": "ENABLED"},"networkZone": "ab-cde-xyz","group": "default","modules": [{"type": "AWS","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "ONE_AGENT_ROUTING","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "Z_OS","enabled": false,"attributes": {},"version": null,"misconfigured": false},{"type": "KUBERNETES","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "METRIC_API","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "EXTENSIONS_V1","enabled": false,"attributes": {},"version": null,"misconfigured": false},{"type": "VMWARE","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "CLOUD_FOUNDRY","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "SYNTHETIC","enabled": false,"attributes": {"SYNTHETIC_BROWSER_MONITOR": "false","SYNTHETIC_HTTP_MONITOR": "false"},"version": null,"misconfigured": false},{"type": "DB_INSIGHT","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "REST_API","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "OTLP_INGEST","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "MEMORY_DUMPS","enabled": false,"attributes": {},"version": null,"misconfigured": false},{"type": "AZURE","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "LOGS","enabled": true,"attributes": {},"version": null,"misconfigured": false},{"type": "EXTENSIONS_V2","enabled": false,"attributes": {},"version": null,"misconfigured": false},{"type": "BEACON_FORWARDER","enabled": true,"attributes": {},"version": null,"misconfigured": false}],"containerized": false,"connectedHosts": {"number": 3},"activeGateTokens": [{"state": "VALID","id": "dt0g02.ABC2FTDE","environmentId": null}]}]}
Response code
200