Network zones API - GET a network zone
Gets information about the specified network zone.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET |
|
Authentication
To execute this request, you need the Read network zones (networkZones.read) permission assigned to your API token. To learn how to obtain and use it, see Authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required network zone. | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Network | Success |
Response body objects
The NetworkZone object
Configuration of a network zone.
| Element | Type | Description | Required |
|---|---|---|---|
| numOfOneAgentsUsing | integer | The number of OneAgents that are using ActiveGates in the network zone. | optional |
| alternativeZones | string[] | A list of alternative network zones. | optional |
| numOfConfiguredOneAgents | integer | The number of OneAgents that are configured to use the network zone as primary. | optional |
| numOfConfiguredActiveGates | integer | The number of ActiveGates in the network zone. | optional |
| numOfOneAgentsFromOtherZones | integer | The number of OneAgents from other network zones that are using ActiveGates in the network zone. This is a fraction of numOfOneAgentsUsing. One possible reason for switching to another zone is that a firewall is preventing a OneAgent from connecting to any ActiveGate in the preferred network zone. | optional |
| id | string | The ID of the network zone | optional |
| description | string | A short description of the network zone | optional |
Response body JSON model
{
"numOfOneAgentsUsing": 1,
"alternativeZones": [
"string"
],
"numOfConfiguredOneAgents": 1,
"numOfConfiguredActiveGates": 1,
"numOfOneAgentsFromOtherZones": 1,
"id": "string",
"description": "string"
}