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

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

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

ParameterTypeDescriptionInRequired
idstring

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.

pathrequired
bodyNetworkZone

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

bodyrequired

Request body objects

The NetworkZone object

Configuration of a network zone.

ElementTypeDescriptionRequired
alternativeZonesstring[]

A list of alternative network zones.

optional
numOfOneAgentsUsinginteger

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

optional
numOfConfiguredOneAgentsinteger

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

optional
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.

optional
numOfConfiguredActiveGatesinteger

The number of ActiveGates in the network zone.

optional
idstring

The ID of the network zone

optional
descriptionstring

A short description of the network zone

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "alternativeZones": [ "string" ], "numOfOneAgentsUsing": 1, "numOfConfiguredOneAgents": 1, "numOfOneAgentsFromOtherZones": 1, "numOfConfiguredActiveGates": 1, "id": "string", "description": "string" }

Response

Response codes

CodeTypeDescription
201EntityShortRepresentation

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.

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

json
{ "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity", "description": "Dynatrace entity for the REST API example" }
Related topics
  • Network zones

    Find out how network zones work in Dynatrace.