Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Monitors Monitor Muting API

3 actions 3 updates phrasing extends openapi/datadog-monitor-muting-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Datadog's API. It is a proposal applied on top of the contract, not a document Datadog publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v1/monitor/{monitor_id}/mute'].post
$.paths['/api/v1/monitor/{monitor_id}/unmute'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Datadog Monitors Monitor Muting API
  version: 1.0.0
extends: openapi/datadog-monitor-muting-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/v1/monitor/{monitor_id}/mute'].post
  update:
    x-apievangelist-phrasing:
      intent: Mute a monitor
      effect: write
      questions:
      - How do I silence alerts from a monitor during maintenance?
      - Can I mute a monitor for only certain groups and have it unmute automatically?
      - Does a muted monitor keep evaluating its query?
      instructions:
      - text: Mute monitor {monitor_id}.
        slots:
          monitor_id: path.monitor_id
      - text: Mute monitor {monitor_id} for scope {scope} until {end}.
        slots:
          monitor_id: path.monitor_id
          scope: requestBody.scope
          end: requestBody.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitor/{monitor_id}/unmute'].post
  update:
    x-apievangelist-phrasing:
      intent: Unmute a monitor
      effect: write
      questions:
      - How do I turn alert notifications back on for a muted monitor?
      - Can I unmute just one group of a monitor and leave the rest muted?
      instructions:
      - text: Unmute monitor {monitor_id} everywhere.
        slots:
          monitor_id: path.monitor_id
      - text: Unmute monitor {monitor_id} only for scope {scope}.
        slots:
          monitor_id: path.monitor_id
          scope: requestBody.scope
      - text: Unmute all scopes of monitor {monitor_id} by setting all_scopes to {all_scopes}.
        slots:
          monitor_id: path.monitor_id
          all_scopes: requestBody.all_scopes
      method: generated
      generated: '2026-10-01'