Datadog · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Datadog All API

39 actions 39 updates phrasing extends openapi/datadog-all-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 39 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v2/api_keys'].get
$.paths['/api/v2/apm/config/metrics'].get
$.paths['/api/v2/apm/config/retention-filters'].get
$.paths['/api/v2/application_keys'].get
$.paths['/api/v2/authn_mappings'].get
$.paths['/api/v2/cases/projects'].get
$.paths['/api/v2/container_images'].get
$.paths['/api/v2/containers'].get
$.paths['/api/v2/current_user/application_keys'].get
$.paths['/api/v2/downtime'].get
$.paths['/api/v2/integration/aws/accounts'].get
$.paths['/api/v2/integration/ms-teams/configuration/tenant-based-handles'].get
$.paths['/api/v2/integration/ms-teams/configuration/workflows-webhook-handles'].get
$.paths['/api/v2/integration/opsgenie/services'].get
$.paths['/api/v2/logs/config/archives'].get

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 All API
  version: 1.0.0
extends: openapi/datadog-all-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: 38
- target: $.paths['/api/v2/api_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organization's API keys
      effect: read
      questions:
      - Which Datadog API keys exist in my organization?
      - Can I find API keys that were created after a certain date?
      - Is there a way to see only API keys with remote config read enabled?
      instructions:
      - text: List API keys whose name matches {filter}.
        slots:
          filter: query.filter
      - text: Show API keys created since {start_date}.
        slots:
          start_date: query.filter[created_at][start]
      - text: List API keys in category {category}, sorted by {sort}.
        slots:
          category: query.filter[category]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/apm/config/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List span-based metrics
      effect: read
      questions:
      - What span-based metrics have we configured from APM traces?
      - Where can I see the definitions of all metrics generated from spans?
      instructions:
      - text: List every span-based metric and its definition.
      - text: Show me all the metrics we generate from APM spans.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/apm/config/retention-filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List APM retention filters
      effect: read
      questions:
      - Which APM retention filters decide what traces we keep?
      - Can I see all the span retention filters set up for APM?
      instructions:
      - text: List all APM retention filters.
      - text: Show the retention filters applied to our APM spans.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/application_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List all application keys in the org
      effect: read
      questions:
      - What application keys exist across my whole organization?
      - Can I filter the org's application keys by creation date?
      - Is it possible to include each application key's owner in the listing?
      instructions:
      - text: List every application key in the org matching {filter}.
        slots:
          filter: query.filter
      - text: Show org application keys created between {start} and {end}.
        slots:
          start: query.filter[created_at][start]
          end: query.filter[created_at][end]
      - text: List all org application keys including {include} details.
        slots:
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/authn_mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List AuthN mappings
      effect: read
      questions:
      - Which SAML attribute mappings assign roles in my org?
      - How do I see all authentication mappings for teams instead of roles?
      instructions:
      - text: List all AuthN mappings.
      - text: List AuthN mappings of resource type {resource_type}.
        slots:
          resource_type: query.resource_type
      - text: Find AuthN mappings matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/cases/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Case Management projects
      effect: read
      questions:
      - What case management projects exist in our Datadog org?
      - Can I get every project that cases can be filed under?
      instructions:
      - text: List all case projects.
      - text: Show me every Case Management project.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/container_images'].get
  update:
    x-apievangelist-phrasing:
      intent: List container images
      effect: read
      questions:
      - Which container images are running across my infrastructure?
      - Can I group container images by a tag like image name or registry?
      instructions:
      - text: List container images tagged {tags}.
        slots:
          tags: query.filter[tags]
      - text: Group our container images by {group_by}.
        slots:
          group_by: query.group_by
      - text: List container images sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/containers'].get
  update:
    x-apievangelist-phrasing:
      intent: List running containers
      effect: read
      questions:
      - What containers are running in my organization right now?
      - Can I filter the container list down to a specific tag?
      instructions:
      - text: List all containers tagged {tags}.
        slots:
          tags: query.filter[tags]
      - text: Group our containers by {group_by}.
        slots:
          group_by: query.group_by
      - text: Show every container Datadog sees.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/current_user/application_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own application keys
      effect: read
      questions:
      - Which application keys do I personally own?
      - Can I search only the application keys belonging to my user?
      instructions:
      - text: List the application keys I own.
      - text: Find my own application keys matching {filter}.
        slots:
          filter: query.filter
      - text: Show my application keys created since {start}.
        slots:
          start: query.filter[created_at][start]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/downtime'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled downtimes
      effect: read
      questions:
      - What downtimes are scheduled across our monitors?
      - Can I see only the downtimes that are active right now?
      instructions:
      - text: List all scheduled downtimes.
      - text: List downtimes with current_only set to {current_only}.
        slots:
          current_only: query.current_only
      - text: Show up to {limit} downtimes.
        slots:
          limit: query.page[limit]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/integration/aws/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS account integrations
      effect: read
      questions:
      - Which AWS accounts are connected to Datadog?
      - Is a particular AWS account ID already integrated?
      instructions:
      - text: List all AWS account integration configs.
      - text: Show the AWS integration config for account {aws_account_id}.
        slots:
          aws_account_id: query.aws_account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/integration/ms-teams/configuration/tenant-based-handles'].get
  update:
    x-apievangelist-phrasing:
      intent: List Microsoft Teams tenant-based handles
      effect: read
      questions:
      - What tenant-based handles are set up in the Microsoft Teams integration?
      - Can I look up Teams handles for one specific tenant?
      instructions:
      - text: List all Microsoft Teams tenant-based handles.
      - text: List tenant-based handles for tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: Find the tenant-based handle named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/integration/ms-teams/configuration/workflows-webhook-handles'].get
  update:
    x-apievangelist-phrasing:
      intent: List Microsoft Teams Workflows webhook handles
      effect: read
      questions:
      - Which Workflows webhook handles exist for Microsoft Teams?
      - Can I find a Teams Workflows webhook handle by its name?
      instructions:
      - text: List all Microsoft Teams Workflows webhook handles.
      - text: Find the Workflows webhook handle called {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/integration/opsgenie/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List Opsgenie integration services
      effect: read
      questions:
      - What Opsgenie services are configured in Datadog?
      - Where do I see all service objects from the Opsgenie integration?
      instructions:
      - text: List all Opsgenie services.
      - text: Show the service objects in our Opsgenie integration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives'].get
  update:
    x-apievangelist-phrasing:
      intent: List logs archives
      effect: read
      questions:
      - Which logs archives have we configured?
      - Can I see where each logs archive is sending our logs?
      instructions:
      - text: List all logs archives with their definitions.
      - text: Show every configured logs archive.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/custom-destinations'].get
  update:
    x-apievangelist-phrasing:
      intent: List logs custom destinations
      effect: read
      questions:
      - What custom destinations are logs being forwarded to?
      - Can I view all custom log forwarding destinations in my org?
      instructions:
      - text: List all logs custom destinations.
      - text: Show where we forward logs via custom destinations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List log-based metrics
      effect: read
      questions:
      - Which metrics have we generated from logs?
      - Is there a list of all log-based metric definitions?
      instructions:
      - text: List all log-based metrics.
      - text: Show every metric we derive from log data.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/restriction_queries/user/{user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List restriction queries for a user
      effect: read
      questions:
      - Which log restriction queries apply to a given user?
      - Can I check what logs a specific user is restricted to seeing?
      instructions:
      - text: List restriction queries that apply to user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show the log restriction queries for {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/monitor/notification_rule'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitor notification rules
      effect: read
      questions:
      - What monitor notification rules are configured in my org?
      - Can I see who gets notified by each monitor notification rule?
      instructions:
      - text: List all monitor notification rules.
      - text: List monitor notification rules including {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/monitor/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitor configuration policies
      effect: read
      questions:
      - Which monitor configuration policies are enforced, like required tags?
      - Can I see every policy governing how monitors are configured?
      instructions:
      - text: List all monitor configuration policies.
      - text: Show the policies that govern monitor configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/powerpacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List powerpacks
      effect: read
      questions:
      - What powerpacks are available to reuse in dashboards?
      - Can I page through the powerpacks in my org?
      instructions:
      - text: List all powerpacks.
      - text: Show up to {limit} powerpacks starting at offset {offset}.
        slots:
          limit: query.page[limit]
          offset: query.page[offset]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/processes'].get
  update:
    x-apievangelist-phrasing:
      intent: List running processes
      effect: read
      questions:
      - Which processes are running across my hosts?
      - Can I search processes by name within a time window?
      instructions:
      - text: Find processes matching {search}.
        slots:
          search: query.search
      - text: List processes tagged {tags}.
        slots:
          tags: query.tags
      - text: Show processes seen between {from} and {to}.
        slots:
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/asm/waf/custom_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List WAF custom rules
      effect: read
      questions:
      - What custom WAF rules do we have in Application Security?
      - Can I see all user-defined WAF rules?
      instructions:
      - text: List all WAF custom rules.
      - text: Show our Application Security custom WAF rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/asm/waf/exclusion_filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List WAF exclusion filters
      effect: read
      questions:
      - Which WAF exclusion filters are skipping traffic from inspection?
      - Can I list every Application Security exclusion filter?
      instructions:
      - text: List all WAF exclusion filters.
      - text: Show the exclusion filters configured for the WAF.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/cws/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: List Workload Protection policies
      effect: read
      questions:
      - What Workload Protection agent policies do we have?
      - Is the Workload Protection policy list available on the US1-FED site?
      instructions:
      - text: List all Workload Protection policies.
      - text: Show every Workload Protection agent policy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/roles/{role_id}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users who have a role
      effect: read
      questions:
      - Which users are assigned to a particular role?
      - Can I search the members of a role by name?
      instructions:
      - text: List the users in role {role_id}.
        slots:
          role_id: path.role_id
      - text: Find users in role {role_id} matching {filter}.
        slots:
          role_id: path.role_id
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List RUM applications
      effect: read
      questions:
      - Which RUM applications are set up in our org?
      - Can I see every real user monitoring app we track?
      instructions:
      - text: List all RUM applications.
      - text: Show the RUM apps in my organization.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/applications/{app_id}/retention_filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List RUM retention filters for an app
      effect: read
      questions:
      - Which RUM retention filters apply to a given application?
      - Can I see what RUM sessions are kept for one app?
      instructions:
      - text: List RUM retention filters for application {app_id}.
        slots:
          app_id: path.app_id
      - text: Show the retention filters on RUM app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/rum/config/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List RUM-based metrics
      effect: read
      questions:
      - What metrics have we generated from RUM events?
      - Is there a list of all rum-based metric definitions?
      instructions:
      - text: List all RUM-based metrics.
      - text: Show every metric derived from real user monitoring data.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/scorecard/outcomes'].get
  update:
    x-apievangelist-phrasing:
      intent: List scorecard rule outcomes
      effect: read
      questions:
      - How are my services scoring against scorecard rules?
      - Can I see which services are failing a specific scorecard rule?
      instructions:
      - text: List scorecard outcomes for service {service_name}.
        slots:
          service_name: query.filter[outcome][service_name]
      - text: Show scorecard outcomes in state {state}.
        slots:
          state: query.filter[outcome][state]
      - text: List outcomes for the scorecard rule named {rule_name}.
        slots:
          rule_name: query.filter[rule][name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/scorecard/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List scorecard rules
      effect: read
      questions:
      - Which scorecard rules are defined for our services?
      - Can I list only the custom scorecard rules?
      instructions:
      - text: List all scorecard rules.
      - text: List scorecard rules with custom set to {custom}.
        slots:
          custom: query.filter[rule][custom]
      - text: Find the scorecard rule named {name}.
        slots:
          name: query.filter[rule][name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/configuration/security_filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List security filters
      effect: read
      questions:
      - Which security filters limit what logs Cloud SIEM analyzes?
      - Can I see every configured security filter definition?
      instructions:
      - text: List all security filters.
      - text: Show the security filters for security monitoring.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/configuration/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List security suppression rules
      effect: read
      questions:
      - What suppression rules are muting security signals?
      - Can I see all security monitoring suppressions?
      instructions:
      - text: List all suppression rules.
      - text: Show every security signal suppression rule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List incident services
      effect: read
      questions:
      - Which incident services are defined for our org?
      - Can I search incident services by name?
      instructions:
      - text: List all incident services.
      - text: Find incident services named like {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/services/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Service Catalog definitions
      effect: read
      questions:
      - What services are registered in the Service Catalog?
      - Can I get service definitions in a particular schema version?
      instructions:
      - text: List all service definitions.
      - text: List service definitions using schema version {schema_version}.
        slots:
          schema_version: query.schema_version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/team'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams
      effect: read
      questions:
      - Which teams exist in my Datadog organization?
      - Can I find just the teams I belong to?
      - How do I search teams by a member's email?
      instructions:
      - text: Search teams for {keyword}.
        slots:
          keyword: query.filter[keyword]
      - text: List teams with filter[me] set to {me}.
        slots:
          me: query.filter[me]
      - text: List all teams in the org.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List incident teams
      effect: read
      questions:
      - What incident teams are set up for incident response?
      - Can I filter incident teams by name?
      instructions:
      - text: List all incident teams.
      - text: Find incident teams named like {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the organization
      effect: read
      questions:
      - Who are all the users in my Datadog org, including deactivated ones?
      - Can I list only users with Pending status?
      instructions:
      - text: List users with status {status}.
        slots:
          status: query.filter[status]
      - text: Find users matching {filter}.
        slots:
          filter: query.filter
      - text: List all users sorted by {sort} in {sort_dir} order.
        slots:
          sort: query.sort
          sort_dir: query.sort_dir
      method: generated
      generated: '2026-10-01'