Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog Convert API

4 actions 4 updates phrasing extends openapi/datadog-convert-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 4

$.info
$.paths['/api/v2/security_monitoring/rules/convert'].post
$.paths['/api/v2/security_monitoring/rules/{rule_id}/convert'].get
$.paths['/api/v2/siem-historical-detections/jobs/signal_convert'].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 Convert API
  version: 1.0.0
extends: openapi/datadog-convert-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: 3
- target: $.paths['/api/v2/security_monitoring/rules/convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a draft rule's JSON to Terraform
      effect: read
      questions:
      - Can I turn a detection rule I haven't created yet into Terraform config?
      - How do I get datadog_security_monitoring_rule Terraform from rule JSON?
      instructions:
      - text: Convert this new rule's JSON definition to Terraform.
      - text: Generate Terraform for a security rule that doesn't exist yet.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/rules/{rule_id}/convert'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an existing rule as Terraform
      effect: read
      questions:
      - How do I export an existing detection rule as Terraform?
      - Can I bring a rule I already created under Terraform management?
      instructions:
      - text: Convert existing rule {rule_id} to Terraform.
        slots:
          rule_id: path.rule_id
      - text: Export security rule {rule_id} as a Terraform resource.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/siem-historical-detections/jobs/signal_convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a historical job result to a signal
      effect: write
      questions:
      - Can I turn a historical detection job result into a security signal?
      - How do I promote a finding from a historical job to a real signal?
      instructions:
      - text: Convert the historical job result {result} into a signal.
        slots:
          result: requestBody.data
      - text: Create a security signal from job result {result}.
        slots:
          result: requestBody.data
      method: generated
      generated: '2026-10-01'