• Home
  • Dynatrace API
  • Environment
  • Network zones
  • GET all network zones

Network zones API - GET all network zones

Lists all existing network zones.

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

  • Dynatrace SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/networkZones
  • Dynatrace 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

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200NetworkZoneList

Success

Response body objects

The NetworkZoneList object

A list of network zones.

ElementTypeDescription
networkZonesNetworkZone[]

A list of network zones.

The NetworkZone object

Configuration of a network zone.

ElementTypeDescription
alternativeZonesstring[]

A list of alternative network zones.

numOfOneAgentsUsinginteger

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

numOfConfiguredOneAgentsinteger

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

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.

numOfConfiguredActiveGatesinteger

The number of ActiveGates in the network zone.

descriptionstring

A short description of the network zone

idstring

The ID of the network zone

Response body JSON model

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

    Find out how network zones work in Dynatrace.