Network zones - Settings API

• Dynatrace Classic
• How-to guide
• 2-min read
• Published Jul 16, 2026

You can manage network zones programmatically using the Settings API with the builtin:networkzones.zones schema. This page covers the network-zone-specific details. For general Settings API behavior—pagination, filtering, and error responses—see the Settings API reference.

Authentication

All requests require an API token. To learn how to obtain and use it, see Authentication.

The required token permission depends on the operation:

Operations

All operations use the /api/v2/settings/objects endpoint. Prepend the base URL for your deployment to the path shown in the table below:

SaaS https://{your-environment-id}.live.dynatrace.com

Network zone fields

The create and update operations accept a value object in the request body. Its properties are described below.

Examples

Get a single network zone

GET /api/v2/settings/objects/{object-id}

Response; not all properties are shown in this example:

{
  "objectId": "<objectId>",
  "created": 1782827712752,
  "modified": 1782887796575,
  "scope": "environment",
  "schemaId": "builtin:networkzones.zones",
  "value": {
    "id": "my-network-zone",
    "alternativeZones": [],
    "fallbackMode": "ANY_ACTIVE_GATE"
  }
}

Create a network zone

POST /api/v2/settings/objects

[
  {
    "schemaId": "builtin:networkzones.zones",
    "scope": "environment",
    "value": {
      "id": "my-network-zone",
      "description": "My new network zone",
      "alternativeZones": [],
      "fallbackMode": "ANY_ACTIVE_GATE"
    }
  }
]

Response; returns the status and object ID of the created network zone:

[
  {
    "code": 200,
    "objectId": "<objectId>"
  }
]

Update a network zone

The request body must include all fields; this is a full replacement, not a partial update. The id field must be present but cannot be changed.

PUT /api/v2/settings/objects/{object-id}

{
  "value": {
    "id": "my-network-zone",
    "description": "Updated description",
    "alternativeZones": [],
    "fallbackMode": "ANY_ACTIVE_GATE"
  }
}

Response:

{
  "code": 200,
  "objectId": "<objectId>"
}

Delete a network zone

DELETE /api/v2/settings/objects/{object-id}

A successful deletion returns 204 No Content with no response body.