Network zones API - GET a network zone

  • Reference
  • Published Mar 05, 2020

Gets information about the specified network zone.

The request produces an application/json payload.

GET

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

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The NetworkZone object

Configuration of a network zone.

ElementTypeDescription
alternativeZonesstring[]

A list of alternative network zones.

descriptionstring

A short description of the network zone.

fallbackModestring

The fallback mode of the network zone.

The element can hold these values
  • ANY_ACTIVE_GATE
  • NONE
  • ONLY_DEFAULT_ZONE
idstring

The ID of the network zone.

numOfConfiguredActiveGatesinteger

The number of 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.

numOfOneAgentsUsinginteger

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

overridesGlobalboolean

Indicates if a global network zone is overridden (managed only).

scopestring

Specifies the scope of the network zone (managed only).

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "alternativeZones": [
    "string"
  ],
  "description": "string",
  "fallbackMode": "ANY_ACTIVE_GATE",
  "id": "string",
  "numOfConfiguredActiveGates": 1,
  "numOfConfiguredOneAgents": 1,
  "numOfOneAgentsFromOtherZones": 1,
  "numOfOneAgentsUsing": 1,
  "overridesGlobal": true,
  "scope": "string"
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}