• Home
  • Dynatrace API
  • Environment
  • Network zones
  • GET a network zone

Network zones API - GET a network zone

Gets information about the specified network zone.

The request produces an application/json payload.

Early Adopter

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

GET
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/networkZones/{id}
  • Managed Use the Cluster API.

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

ParameterTypeDescriptionInRequired
idstring

The ID of the required network zone.

pathrequired

Response

Response codes

CodeTypeDescription
200NetworkZone

Success

Response body objects

The NetworkZone object

Configuration of a network zone.

ElementTypeDescription
numOfConfiguredOneAgentsinteger

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

Can be null.

numOfOneAgentsFromOtherZonesinteger

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.

Can be null.

numOfConfiguredActiveGatesinteger

The number of ActiveGates in the network zone.

Can be null.

alternativeZonesstring[]

A list of alternative network zones.

Can be null.

numOfOneAgentsUsinginteger

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

Can be null.

idstring

The ID of the network zone

Can be null.

descriptionstring

A short description of the network zone

Can be null.

Response body JSON model

json
{ "numOfConfiguredOneAgents": 1, "numOfOneAgentsFromOtherZones": 1, "numOfConfiguredActiveGates": 1, "alternativeZones": [ "string" ], "numOfOneAgentsUsing": 1, "id": "string", "description": "string" }
Related topics
  • Network zones

    Find out how network zones work in Dynatrace.