Datadog · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Datadog Lists API
17 actions
17 updates
phrasing
extends
openapi/datadog-lists-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.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/api/v2/apicatalog/api'].get
$.paths['/api/v2/cloud_security_management/resource_filters'].get
$.paths['/api/v2/integrations/fastly/accounts/{account_id}/services'].get
$.paths['/api/v2/logs/config/restriction_queries'].get
$.paths['/api/v2/logs/config/restriction_queries/{restriction_query_id}/roles'].get
$.paths['/api/v2/metrics/{metric_name}/all-tags'].get
$.paths['/api/v2/metrics/{metric_name}/volumes'].get
$.paths['/api/v2/org_configs'].get
$.paths['/api/v2/permissions'].get
$.paths['/api/v2/remote_config/products/obs_pipelines/pipelines'].get
$.paths['/api/v2/roles'].get
$.paths['/api/v2/roles/{role_id}/permissions'].get
$.paths['/api/v2/scim/Users'].get
$.paths['/api/v2/security/vulnerabilities'].get
$.paths['/api/v2/security_monitoring/rules'].get
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 Datadog Lists API
version: 1.0.0
extends: openapi/datadog-lists-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: 16
- target: $.paths['/api/v2/apicatalog/api'].get
update:
x-apievangelist-phrasing:
intent: List APIs in the API Catalog
effect: read
questions:
- Which APIs are registered in our API Catalog, and what are their IDs?
- Can I filter the API Catalog list by API name?
instructions:
- text: List the APIs in our API Catalog.
- text: Find catalog APIs whose name matches {query}.
slots:
query: query.query
- text: Show {limit} catalog APIs starting at offset {offset}.
slots:
limit: query.page[limit]
offset: query.page[offset]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/cloud_security_management/resource_filters'].get
update:
x-apievangelist-phrasing:
intent: List cloud resource evaluation filters
effect: read
questions:
- Which resource filters are excluding cloud resources from security evaluation?
- Can I see the resource filters for just one AWS or GCP account?
instructions:
- text: List resource filters for cloud provider {cloud_provider}.
slots:
cloud_provider: query.cloud_provider
- text: Show the resource filters for {cloud_provider} account {account_id}.
slots:
cloud_provider: query.cloud_provider
account_id: query.account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/integrations/fastly/accounts/{account_id}/services'].get
update:
x-apievangelist-phrasing:
intent: List Fastly services for an account
effect: read
questions:
- Which Fastly services are attached to my connected Fastly account?
- Can I see the services behind one Fastly account in the integration?
instructions:
- text: List the Fastly services for account {account_id}.
slots:
account_id: path.account_id
- text: Show every service under Fastly account {account_id}.
slots:
account_id: path.account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/restriction_queries'].get
update:
x-apievangelist-phrasing:
intent: List log restriction queries
effect: read
questions:
- Which log restriction queries exist in my organization?
- What's the largest page size when listing restriction queries?
instructions:
- text: List all log restriction queries.
- text: Show page {page} of restriction queries, {size} per page.
slots:
page: query.page[number]
size: query.page[size]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/restriction_queries/{restriction_query_id}/roles'].get
update:
x-apievangelist-phrasing:
intent: List roles that have a restriction query
effect: read
questions:
- Which roles are bound to a given log restriction query?
- Can I page through the roles attached to a restriction query?
instructions:
- text: List the roles assigned restriction query {restriction_query_id}.
slots:
restriction_query_id: path.restriction_query_id
- text: Show which roles use restriction query {restriction_query_id}, {size} at a time.
slots:
restriction_query_id: path.restriction_query_id
size: query.page[size]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/metrics/{metric_name}/all-tags'].get
update:
x-apievangelist-phrasing:
intent: List indexed tags for a metric
effect: read
questions:
- What tag key-value pairs are indexed on a metric?
- Does the metric tag listing cover all time or just the last hour?
instructions:
- text: List all indexed tags for metric {metric_name}.
slots:
metric_name: path.metric_name
- text: Show the tag key-value pairs seen on {metric_name} in the past hour.
slots:
metric_name: path.metric_name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/metrics/{metric_name}/volumes'].get
update:
x-apievangelist-phrasing:
intent: Get distinct volumes for a metric
effect: read
questions:
- How many distinct custom metric volumes is one metric producing?
- Why would ingested volume come back null for some metrics?
instructions:
- text: Show the distinct metric volumes for {metric_name}.
slots:
metric_name: path.metric_name
- text: Get ingested and indexed volume for metric {metric_name}.
slots:
metric_name: path.metric_name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/org_configs'].get
update:
x-apievangelist-phrasing:
intent: List organization configs
effect: read
questions:
- What org-level configuration settings are set for my organization?
- Can I see each org config's name, description and value?
instructions:
- text: List all org configs.
- text: Show my organization's configuration settings and their values.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/permissions'].get
update:
x-apievangelist-phrasing:
intent: List all available permissions
effect: read
questions:
- Which permissions exist that I can grant to roles?
- Where can I find permission IDs to use when editing roles?
instructions:
- text: List every available permission with its ID.
- text: Show all permissions and their descriptions.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/remote_config/products/obs_pipelines/pipelines'].get
update:
x-apievangelist-phrasing:
intent: List Observability Pipelines
effect: read
questions:
- Which observability pipelines are configured?
- Can I paginate through the pipelines list?
instructions:
- text: List our observability pipelines.
- text: Show page {page} of pipelines with {size} per page.
slots:
page: query.page[number]
size: query.page[size]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/roles'].get
update:
x-apievangelist-phrasing:
intent: List roles in the organization
effect: read
questions:
- What roles exist in my organization?
- Can I search roles by name or sort them?
instructions:
- text: List all roles.
- text: Find roles matching {filter}.
slots:
filter: query.filter
- text: List roles sorted by {sort}.
slots:
sort: query.sort
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/roles/{role_id}/permissions'].get
update:
x-apievangelist-phrasing:
intent: List the permissions granted to a role
effect: read
questions:
- What permissions does a particular role grant?
- Can I audit exactly what one role is allowed to do?
instructions:
- text: List the permissions on role {role_id}.
slots:
role_id: path.role_id
- text: Show everything role {role_id} is allowed to do.
slots:
role_id: path.role_id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/scim/Users'].get
update:
x-apievangelist-phrasing:
intent: List users through SCIM
effect: read
questions:
- Can my identity provider list users through the SCIM endpoint?
- Is SCIM user pagination 0- or 1-indexed?
instructions:
- text: List SCIM users.
- text: List SCIM users matching filter {filter}.
slots:
filter: query.filter
- text: Fetch {count} SCIM users starting at index {start_index}.
slots:
count: query.count
start_index: query.startIndex
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/security/vulnerabilities'].get
update:
x-apievangelist-phrasing:
intent: List detected vulnerabilities
effect: read
questions:
- Which vulnerabilities affect assets running in production?
- Can I filter vulnerabilities by severity, library or whether a fix is available?
- Can I find vulnerabilities that already have a public exploit?
instructions:
- text: List vulnerabilities with Datadog severity {severity}.
slots:
severity: query.filter[cvss.datadog.severity]
- text: Show vulnerabilities in library {library} that have a fix available.
slots:
library: query.filter[library.name]
- text: List vulnerabilities for advisory {advisory_id}.
slots:
advisory_id: query.filter[advisory_id]
- text: Show vulnerabilities on asset {asset_name}.
slots:
asset_name: query.filter[asset.name]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/security_monitoring/rules'].get
update:
x-apievangelist-phrasing:
intent: List security detection rules
effect: read
questions:
- Which detection rules are configured in Security Monitoring?
- Can I page through detection rules 100 at a time?
instructions:
- text: List all security detection rules.
- text: Show page {page} of detection rules.
slots:
page: query.page[number]
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/sensitive-data-scanner/config/standard-patterns'].get
update:
x-apievangelist-phrasing:
intent: List Sensitive Data Scanner standard patterns
effect: read
questions:
- What built-in patterns can the Sensitive Data Scanner detect?
- Is there a library of standard patterns for things like credit card numbers?
instructions:
- text: List all Sensitive Data Scanner standard patterns.
- text: Show the built-in scanning patterns I can use in a rule.
method: generated
generated: '2026-10-01'