Dynatrace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dynatrace Account Management Environment Management API

6 actions 6 updates phrasing extends openapi/dynatrace-environment-management-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Dynatrace's API. It is a proposal applied on top of the contract, not a document Dynatrace publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/env/v1/accounts/{account-uuid}/environments'].get

$.paths['/env/v2/accounts/{account-uuid}/environments'].get

$.paths['/env/v2/accounts/{account-uuid}/clusters'].get

$.paths['/env/v1/accounts/{account-uuid}/environments/{environment-uuid}/ip-allowlist'].get

$.paths['/env/v1/accounts/{account-uuid}/environments/{environment-uuid}/ip-allowlist'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dynatrace Account Management Environment Management API
  version: 1.0.0
extends: openapi/dynatrace-environment-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/env/v1/accounts/{account-uuid}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments and management zones
      effect: read
      questions:
      - Which management zones exist in each of my environments?
      - Can I get environments together with their management zones in one call?
      instructions:
      - text: List environments and their management zones for account {account}.
        slots:
          account: path.account-uuid
      - text: Show the management zones in every environment of {account}.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/env/v2/accounts/{account-uuid}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments in an account (v2)
      effect: read
      questions:
      - What environments does my account currently have, using the v2 listing?
      - Is there a newer endpoint that lists just the environments, without zones?
      instructions:
      - text: List all environments on account {account} with the v2 endpoint.
        slots:
          account: path.account-uuid
      - text: Get the v2 environment list for {account}.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/env/v2/accounts/{account-uuid}/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List clusters in a managed account
      effect: read
      questions:
      - Which Managed clusters belong to my account?
      - Can I list the clusters behind a managed deployment?
      instructions:
      - text: List the clusters in managed account {account}.
        slots:
          account: path.account-uuid
      - text: Show every cluster registered to {account}.
        slots:
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/env/v1/accounts/{account-uuid}/environments/{environment-uuid}/ip-allowlist'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's IP allowlist
      effect: read
      questions:
      - Which IP addresses are allowed to reach my environment?
      - Is the IP allowlist turned on for a given tenant?
      instructions:
      - text: Show the IP allowlist for environment {environment} in account {account}.
        slots:
          environment: path.environment-uuid
          account: path.account-uuid
      - text: Check whether IP restrictions are enabled on {environment} for {account}.
        slots:
          environment: path.environment-uuid
          account: path.account-uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/env/v1/accounts/{account-uuid}/environments/{environment-uuid}/ip-allowlist'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an environment's IP allowlist
      effect: write
      questions:
      - How do I restrict access to my tenant to specific IP ranges?
      - Can webhooks be exempted from the IP allowlist?
      instructions:
      - text: Enable the IP allowlist {allowlist} on environment {environment} in {account}, webhook override {override}.
        slots:
          allowlist: requestBody.allowlist
          environment: path.environment-uuid
          account: path.account-uuid
          override: requestBody.allowWebhookOverride
      - text: Set IP allowlisting on {environment} for account {account} to enabled={enabled} with webhook override {override}.
        slots:
          environment: path.environment-uuid
          account: path.account-uuid
          enabled: requestBody.enabled
          override: requestBody.allowWebhookOverride
      method: generated
      generated: '2026-09-26'