Network zones API - PUT a network zone

Updates the specified network zone. If the network zone with the specified ID doesn't exist, a new network zone is created.

The request produces and consumes an application/json payload.

Early Adopter

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

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

Parameters

Parameter Type Description In Required
id string

The ID of the network zone to be updated.

If you set the ID in the body as well, it must match this ID.

The ID is not case sensitive. Dynatrace stores the ID in lowercase.

path required
body NetworkZone

The JSON body of the request. Contains parameters of the network zone.

body optional

The NetworkZone object

Configuration of a network zone.

Element Type Description Required
numOfConfiguredActiveGates integer

The number of ActiveGates in the network zone.

optional
alternativeZones string[]

A list of alternative network zones.

optional
numOfOneAgentsUsing integer

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

optional
numOfConfiguredOneAgents integer

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

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 format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Response codes

Code Description
201

Success. The new network zone has been created. The response body contains the ID of the new network zone.

204

Success. The network zone has been updated. Response doesn't have a body.

400

Failed. The input is invalid.