Network zones API - GET global configuration

  • Reference
  • Published Mar 05, 2020

Gets the global configuration of network zones in your environment.

The request produces an application/json payload.

GET

  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/networkZoneSettings

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
200NetworkZoneSettings

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The NetworkZoneSettings object

Global network zone configuration.

ElementTypeDescription
networkZonesEnabledboolean

Network zones feature is enabled (true) or disabled (false).

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

{
  "networkZonesEnabled": true
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}