ActiveGates API - GET an ActiveGate

Gets the information about the specified ActiveGate.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}
  • SaaS https://{your-environment-id}{agId}


To execute this request, you need the Read ActiveGates ( permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
agId string

The ID of the required ActiveGate.

path required


Response codes

Code Description



Not found. See response body for details.

Response body

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.

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 null value means the ActiveGate is online.

version string

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

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.

networkZone string

The network zone of the ActiveGate.

group string

The group of the ActiveGate.


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 -L -X GET 'https://mySampleEnv/api/v2/activeGates/876651882' \
-H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL


Response body

  "id": "876651882",
  "networkAddresses": [
    "osType": "LINUX",
    "autoUpdateStatus": "UPDATE_IN_PROGRESS",
    "offlineSince": null,
    "version": "",
    "type": "ENVIRONMENT",
    "hostname": "",
    "mainEnvironment": null,
    "environments": [
    "networkZone": "easytravel.europe.austria.05"

Response code