Network zones API - GET a network zone

Gets information about the specified network zone.

The request produces an application/json payload.

GET

  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/networkZones/{id}

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

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The NetworkZone object

Configuration of a network zone.

Element
Type
Description
alternativeZones
string[]

A list of alternative network zones.

description
string

A short description of the network zone.

fallbackMode
string

The fallback mode of the network zone.

  • ANY_ACTIVE_GATE
  • NONE
  • ONLY_DEFAULT_ZONE
id
string

The ID of the network zone.

numOfConfiguredActiveGates
integer

The number of ActiveGates in the network zone.

numOfConfiguredOneAgents
integer

The number of OneAgents that are configured to use the network zone as primary.

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.

numOfOneAgentsUsing
integer

The number of OneAgents that are using ActiveGates in the network zone.

overridesGlobal
boolean

Indicates if a global network zone is overridden (managed only).

scope
string

Specifies the scope of the network zone (managed only).

Response body JSON model

{
  "alternativeZones": [
    "string"
  ],
  "description": "string",
  "fallbackMode": "ANY_ACTIVE_GATE",
  "id": "string",
  "numOfConfiguredActiveGates": 1,
  "numOfConfiguredOneAgents": 1,
  "numOfOneAgentsFromOtherZones": 1,
  "numOfOneAgentsUsing": 1,
  "overridesGlobal": true,
  "scope": "string"
}

Related topics