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

Authentication

To execute this request, you need the Deployment management 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

Code Description
200

Success

Response body

The NetworkZoneList object

A list of network zones.

Element Type Description
networkZones NetworkZone[]

A list of network zones.

The NetworkZone object

Configuration of a network zone.

Element Type Description
alternativeZones string[]

A list of alternative network zones.
numOfOneAgentsUsing integer

The number of OneAgents that are using 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.
numOfConfiguredActiveGates integer

The number of ActiveGates in the network zone.
id string

The ID of the network zone
description string

A short description of the network zone