.generator/schemas/v2/openapi.yaml in datadog_api_client-2.26.1 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.27.1
- old
+ new
@@ -449,10 +449,52 @@
in: path
name: metric_name
required: true
schema:
type: string
+ MicrosoftTeamsChannelNamePathParameter:
+ description: Your channel name.
+ in: path
+ name: channel_name
+ required: true
+ schema:
+ type: string
+ MicrosoftTeamsHandleIDPathParameter:
+ description: Your handle id.
+ in: path
+ name: handle_id
+ required: true
+ schema:
+ type: string
+ MicrosoftTeamsHandleNamePathParameter:
+ description: Your handle name.
+ in: path
+ name: handle_name
+ required: true
+ schema:
+ type: string
+ MicrosoftTeamsTeamNamePathParameter:
+ description: Your team name.
+ in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ MicrosoftTeamsTenantIDQueryParameter:
+ description: Your tenant id.
+ in: query
+ name: tenant_id
+ required: false
+ schema:
+ type: string
+ MicrosoftTeamsTenantNamePathParameter:
+ description: Your tenant name.
+ in: path
+ name: tenant_name
+ required: true
+ schema:
+ type: string
OpsgenieServiceIDPathParameter:
description: The UUID of the service.
in: path
name: integration_service_id
required: true
@@ -689,10 +731,16 @@
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
+ PreconditionFailedResponse:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Failed Precondition
SpansBadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
@@ -6499,10 +6547,16 @@
description: Unix timestamp when the deployment started. It must be in nanoseconds,
milliseconds, or seconds.
example: 1693491974000000000
format: int64
type: integer
+ team:
+ description: Name of the team owning the deployed service. If not provided,
+ this is automatically populated with the team associated with the service
+ in the Service Catalog.
+ example: backend
+ type: string
version:
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
example: v1.12.07
type: string
required:
@@ -9140,11 +9194,11 @@
description: The expected response schema when getting Fastly services.
properties:
data:
description: The JSON:API data schema.
items:
- $ref: '#/components/schemas/FastlyServiceResponse'
+ $ref: '#/components/schemas/FastlyServiceData'
type: array
type: object
Finding:
description: A single finding without the message and resource configuration.
properties:
@@ -10382,10 +10436,17 @@
$ref: '#/components/schemas/IncidentTimelineCellCreateAttributes'
type: array
notification_handles:
description: Notification handles that will be notified of the incident
at creation.
+ example:
+ - display_name: Jane Doe
+ handle: '@user@email.com'
+ - display_name: Slack Channel
+ handle: '@slack-channel'
+ - display_name: Incident Workflow
+ handle: '@workflow-from-incident'
items:
$ref: '#/components/schemas/IncidentNotificationHandle'
type: array
title:
description: The title of the incident, which summarizes what happened.
@@ -10668,11 +10729,12 @@
display_name:
description: The name of the notified handle.
example: Jane Doe
type: string
handle:
- description: The email address used for the notification.
+ description: The handle used for the notification. This includes an email
+ address, Slack channel, or workflow.
example: '@test.user@test.com'
type: string
type: object
IncidentPostmortemType:
default: incident_postmortems
@@ -10781,10 +10843,17 @@
non_datadog_creator:
$ref: '#/components/schemas/IncidentNonDatadogCreator'
notification_handles:
description: Notification handles that will be notified of the incident
during update.
+ example:
+ - display_name: Jane Doe
+ handle: '@user@email.com'
+ - display_name: Slack Channel
+ handle: '@slack-channel'
+ - display_name: Incident Workflow
+ handle: '@workflow-from-incident'
items:
$ref: '#/components/schemas/IncidentNotificationHandle'
nullable: true
type: array
public_id:
@@ -11748,10 +11817,17 @@
value: SEV-5
type: object
notification_handles:
description: Notification handles that will be notified of the incident
during update.
+ example:
+ - display_name: Jane Doe
+ handle: '@user@email.com'
+ - display_name: Slack Channel
+ handle: '@slack-channel'
+ - display_name: Incident Workflow
+ handle: '@workflow-from-incident'
items:
$ref: '#/components/schemas/IncidentNotificationHandle'
type: array
title:
description: The title of the incident, which summarizes what happened.
@@ -13909,12 +13985,12 @@
- time: sum, space: avg
- time: sum, space: sum
- Can only be applied to metrics that have a `metric_type` of `count`, `rate`,
- or `gauge`.'
+ Can only be applied to non_distribution metrics that have a `metric_type`
+ of `count`, `rate`, or `gauge`.'
example:
- space: sum
time: sum
- space: sum
time: count
@@ -14518,10 +14594,21 @@
data:
$ref: '#/components/schemas/MetricTagConfigurationCreateData'
required:
- data
type: object
+ MetricTagConfigurationMetricTypeCategory:
+ default: distribution
+ description: The metric's type category.
+ enum:
+ - non_distribution
+ - distribution
+ example: distribution
+ type: string
+ x-enum-varnames:
+ - NON_DISTRIBUTION
+ - DISTRIBUTION
MetricTagConfigurationMetricTypes:
default: gauge
description: The metric's type.
enum:
- gauge
@@ -14720,10 +14807,280 @@
type: string
required:
- data_source
- query
type: object
+ MicrosoftTeamsApiHandleAttributes:
+ description: Handle attributes.
+ properties:
+ channel_id:
+ description: Channel id.
+ example: fake-channel-id
+ maxLength: 255
+ type: string
+ name:
+ description: Handle name.
+ example: fake-handle-name
+ maxLength: 255
+ type: string
+ team_id:
+ description: Team id.
+ example: 00000000-0000-0000-0000-000000000000
+ maxLength: 255
+ type: string
+ tenant_id:
+ description: Tenant id.
+ example: 00000000-0000-0000-0000-000000000001
+ maxLength: 255
+ type: string
+ type: object
+ MicrosoftTeamsApiHandleInfoResponse:
+ description: Response of a handle.
+ properties:
+ data:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponseData'
+ type: object
+ MicrosoftTeamsApiHandleInfoResponseAttributes:
+ description: Handle attributes.
+ properties:
+ channel_id:
+ description: Channel id.
+ example: fake-channel-id
+ maxLength: 255
+ type: string
+ channel_name:
+ description: Channel name.
+ example: fake-channel-name
+ maxLength: 255
+ type: string
+ name:
+ description: Handle name.
+ example: fake-handle-name
+ maxLength: 255
+ type: string
+ team_id:
+ description: Team id.
+ example: 00000000-0000-0000-0000-000000000000
+ maxLength: 255
+ type: string
+ team_name:
+ description: Team name.
+ example: fake-team-name
+ maxLength: 255
+ type: string
+ tenant_id:
+ description: Tenant id.
+ example: 00000000-0000-0000-0000-000000000001
+ maxLength: 255
+ type: string
+ tenant_name:
+ description: Tenant name.
+ example: fake-tenant-name
+ maxLength: 255
+ type: string
+ type: object
+ MicrosoftTeamsApiHandleInfoResponseData:
+ description: Handle data from a response.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponseAttributes'
+ id:
+ description: The ID of the handle.
+ example: 596da4af-0563-4097-90ff-07230c3f9db3
+ maxLength: 100
+ minLength: 1
+ type: string
+ type:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoType'
+ type: object
+ MicrosoftTeamsApiHandleInfoType:
+ default: ms-teams-handle-info
+ description: Handle resource type.
+ enum:
+ - ms-teams-handle-info
+ example: ms-teams-handle-info
+ type: string
+ x-enum-varnames:
+ - MS_TEAMS_HANDLE_INFO
+ MicrosoftTeamsApiHandleRequestAttributes:
+ description: Handle attributes.
+ properties:
+ channel_id:
+ description: Channel id.
+ example: fake-channel-id
+ maxLength: 255
+ type: string
+ name:
+ description: Handle name.
+ example: fake-handle-name
+ maxLength: 255
+ type: string
+ team_id:
+ description: Team id.
+ example: 00000000-0000-0000-0000-000000000000
+ maxLength: 255
+ type: string
+ tenant_id:
+ description: Tenant id.
+ example: 00000000-0000-0000-0000-000000000001
+ maxLength: 255
+ type: string
+ required:
+ - name
+ - channel_id
+ - team_id
+ - tenant_id
+ type: object
+ MicrosoftTeamsApiHandleRequestData:
+ description: Handle data from a response.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleRequestAttributes'
+ type:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleType'
+ required:
+ - type
+ - attributes
+ type: object
+ MicrosoftTeamsApiHandleResponseData:
+ description: Handle data from a response.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleAttributes'
+ id:
+ description: The ID of the handle.
+ example: 596da4af-0563-4097-90ff-07230c3f9db3
+ maxLength: 100
+ minLength: 1
+ type: string
+ type:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleType'
+ type: object
+ MicrosoftTeamsApiHandleType:
+ default: handle
+ description: Specifies the handle resource type.
+ enum:
+ - handle
+ example: handle
+ type: string
+ x-enum-varnames:
+ - HANDLE
+ MicrosoftTeamsApiHandlesResponse:
+ description: Response with a list of handles.
+ properties:
+ data:
+ description: An array of handles.
+ example:
+ - attributes:
+ channelId: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2
+ channelName: General
+ name: general-handle
+ teamId: 00000000-0000-0000-0000-000000000000
+ teamName: Example Team
+ tenantId: 00000000-0000-0000-0000-000000000001
+ tenantName: Company, Inc.
+ id: 596da4af-0563-4097-90ff-07230c3f9db3
+ type: ms-teams-handle-info
+ - attributes:
+ channelId: 19:b41k24b14bn1nwffkernfkwrnfneubgk1@thread.tacv2
+ channelName: General2
+ name: general-handle-2
+ teamId: 00000000-0000-0000-0000-000000000002
+ teamName: Example Team 2
+ tenantId: 00000000-0000-0000-0000-000000000003
+ tenantName: Company, Inc.
+ id: 596da4af-0563-4097-90ff-07230c3f9db4
+ type: ms-teams-handle-info
+ items:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponseData'
+ type: array
+ required:
+ - data
+ type: object
+ MicrosoftTeamsChannelInfoResponseAttributes:
+ description: Channel attributes.
+ properties:
+ is_primary:
+ description: Indicates if this is the primary channel.
+ example: true
+ maxLength: 255
+ type: boolean
+ team_id:
+ description: Team id.
+ example: 00000000-0000-0000-0000-000000000000
+ maxLength: 255
+ type: string
+ tenant_id:
+ description: Tenant id.
+ example: 00000000-0000-0000-0000-000000000001
+ maxLength: 255
+ type: string
+ type: object
+ MicrosoftTeamsChannelInfoResponseData:
+ description: Channel data from a response.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes'
+ id:
+ description: The ID of the channel.
+ example: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2
+ maxLength: 255
+ minLength: 1
+ type: string
+ type:
+ $ref: '#/components/schemas/MicrosoftTeamsChannelInfoType'
+ type: object
+ MicrosoftTeamsChannelInfoType:
+ default: ms-teams-channel-info
+ description: Channel info resource type.
+ enum:
+ - ms-teams-channel-info
+ example: ms-teams-channel-info
+ type: string
+ x-enum-varnames:
+ - MS_TEAMS_CHANNEL_INFO
+ MicrosoftTeamsCreateApiHandleRequest:
+ description: Create handle request.
+ properties:
+ data:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleRequestData'
+ required:
+ - data
+ type: object
+ MicrosoftTeamsCreateApiHandleResponse:
+ description: Response of a handle.
+ properties:
+ data:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleResponseData'
+ required:
+ - data
+ type: object
+ MicrosoftTeamsGetChannelByNameResponse:
+ description: Response with channel, team, and tenant ID information.
+ properties:
+ data:
+ $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseData'
+ type: object
+ MicrosoftTeamsUpdateApiHandleRequest:
+ description: Update handle request.
+ properties:
+ data:
+ $ref: '#/components/schemas/MicrosoftTeamsUpdateApiHandleRequestData'
+ required:
+ - data
+ type: object
+ MicrosoftTeamsUpdateApiHandleRequestData:
+ description: Handle data from a response.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleAttributes'
+ type:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleType'
+ required:
+ - type
+ - attributes
+ type: object
MonitorConfigPolicyAttributeCreateRequest:
description: Policy and policy type for a monitor configuration policy.
properties:
policy:
$ref: '#/components/schemas/MonitorConfigPolicyPolicyCreateRequest'
@@ -16215,10 +16572,22 @@
type: string
type: object
PowerpackTemplateVariable:
description: Powerpack template variables.
properties:
+ available_values:
+ description: The list of values that the template variable drop-down is
+ limited to.
+ example:
+ - my-host
+ - host1
+ - host2
+ items:
+ description: Template variable value.
+ type: string
+ nullable: true
+ type: array
defaults:
description: One or many template variable default values within the saved
view, which are unioned together using `OR` if more than one is specified.
items:
description: One or many default values of the template variable.
@@ -16227,10 +16596,16 @@
type: array
name:
description: The name of the variable.
example: datacenter
type: string
+ prefix:
+ description: The tag prefix associated with the variable. Only tags with
+ this prefix appear in the variable drop-down.
+ example: host
+ nullable: true
+ type: string
required:
- name
type: object
PowerpacksResponseMeta:
description: Powerpack response metadata.
@@ -19030,10 +19405,29 @@
$ref: '#/components/schemas/SecurityMonitoringRuleResponse'
type: array
meta:
$ref: '#/components/schemas/ResponseMetaAttributes'
type: object
+ SecurityMonitoringReferenceTable:
+ description: Reference table for the rule.
+ properties:
+ checkPresence:
+ description: Whether to include or exclude the matched values.
+ type: boolean
+ columnName:
+ description: The name of the column in the reference table.
+ type: string
+ logFieldPath:
+ description: The field in the log to match against the reference table.
+ type: string
+ ruleQueryName:
+ description: The name of the rule query to apply the reference table to.
+ type: string
+ tableName:
+ description: The name of the reference table.
+ type: string
+ type: object
SecurityMonitoringRuleCase:
description: Case when signal is generated.
properties:
condition:
description: 'A rule case contains logical operations (`>`,`>=`, `&&`, `||`)
@@ -19535,10 +19929,15 @@
queries:
description: Queries for selecting logs which are part of the rule.
items:
$ref: '#/components/schemas/SecurityMonitoringRuleQuery'
type: array
+ referenceTables:
+ description: Reference tables for the rule.
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
+ type: array
tags:
description: Tags for generated signals.
items:
description: Tag.
type: string
@@ -20239,10 +20638,15 @@
description: Queries for selecting logs which are part of the rule.
example: []
items:
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
+ referenceTables:
+ description: Reference tables for the rule.
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
+ type: array
tags:
description: Tags for generated signals.
example:
- env:prod
- team:security
@@ -20306,10 +20710,15 @@
description: Queries for selecting logs which are part of the rule.
example: []
items:
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
+ referenceTables:
+ description: Reference tables for the rule.
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
+ type: array
tags:
description: Tags for generated signals.
example:
- env:prod
- team:security
@@ -20446,10 +20855,15 @@
queries:
description: Queries for selecting logs which are part of the rule.
items:
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
+ referenceTables:
+ description: Reference tables for the rule.
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
+ type: array
tags:
description: Tags for generated signals.
items:
description: Tag.
type: string
@@ -20510,10 +20924,15 @@
description: Queries for selecting logs which are part of the rule.
example: []
items:
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
+ referenceTables:
+ description: Reference tables for the rule.
+ items:
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
+ type: array
tags:
description: Tags for generated signals.
example:
- env:prod
- team:security
@@ -23945,16 +24364,10 @@
banner:
description: Banner selection for the team
format: int64
nullable: true
type: integer
- color:
- description: An identifier for the color representing the team
- format: int32
- maximum: 13
- minimum: 0
- type: integer
description:
description: Free-form markdown description/content for the team's homepage
type: string
handle:
description: The team's identifier
@@ -25268,10 +25681,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all API keys
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - api_keys_read
post:
description: Create an API key.
operationId: CreateAPIKey
requestBody:
content:
@@ -25302,10 +25719,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create an API key
tags:
- Key Management
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - api_keys_write
/api/v2/api_keys/{api_key_id}:
delete:
description: Delete an API key.
operationId: DeleteAPIKey
parameters:
@@ -25328,10 +25749,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete an API key
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - api_keys_delete
get:
description: Get an API key.
operationId: GetAPIKey
parameters:
- $ref: '#/components/parameters/APIKeyId'
@@ -25358,10 +25783,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get API key
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - api_keys_read
patch:
description: Update an API key.
operationId: UpdateAPIKey
parameters:
- $ref: '#/components/parameters/APIKeyId'
@@ -25400,10 +25829,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Edit an API key
tags:
- Key Management
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - api_keys_write
/api/v2/apicatalog/api:
get:
description: List APIs and their IDs.
operationId: ListAPIs
parameters:
@@ -25688,10 +26121,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all span-based metrics
tags:
- Spans Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_read
post:
description: 'Create a metric based on your ingested spans in your organization.
Returns the span-based metric object from the request body when the request
is successful.'
@@ -25720,10 +26157,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a span-based metric
tags:
- Spans Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_generate_metrics
/api/v2/apm/config/metrics/{metric_id}:
delete:
description: Delete a specific span-based metric from your organization.
operationId: DeleteSpansMetric
parameters:
@@ -25738,10 +26179,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a span-based metric
tags:
- Spans Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_generate_metrics
get:
description: Get a specific span-based metric from your organization.
operationId: GetSpansMetric
parameters:
- $ref: '#/components/parameters/SpansMetricIDParameter'
@@ -25759,10 +26204,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a span-based metric
tags:
- Spans Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_read
patch:
description: 'Update a specific span-based metric from your organization.
Returns the span-based metric object from the request body when the request
is successful.'
@@ -25793,10 +26242,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a span-based metric
tags:
- Spans Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_generate_metrics
/api/v2/apm/config/retention-filters:
get:
description: Get the list of APM retention filters.
operationId: ListApmRetentionFilters
responses:
@@ -25811,10 +26264,15 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List all APM retention filters
tags:
- APM Retention Filters
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_retention_filter_read
+ - apm_pipelines_read
post:
description: 'Create a retention filter to index spans in your organization.
Returns the retention filter definition when the request is successful.
@@ -25846,10 +26304,15 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a retention filter
tags:
- APM Retention Filters
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_retention_filter_write
+ - apm_pipelines_write
/api/v2/apm/config/retention-filters-execution-order:
put:
description: Re-order the execution order of retention filters.
operationId: ReorderApmRetentionFilters
requestBody:
@@ -25870,10 +26333,15 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Re-order retention filters
tags:
- APM Retention Filters
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_retention_filter_write
+ - apm_pipelines_write
/api/v2/apm/config/retention-filters/{filter_id}:
delete:
description: 'Delete a specific retention filter from your organization.
@@ -25892,10 +26360,15 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a retention filter
tags:
- APM Retention Filters
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_retention_filter_write
+ - apm_pipelines_write
get:
description: Get an APM retention filter.
operationId: GetApmRetentionFilter
parameters:
- $ref: '#/components/parameters/RetentionFilterIdParam'
@@ -25913,10 +26386,15 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a given APM retention filter
tags:
- APM Retention Filters
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_retention_filter_read
+ - apm_pipelines_read
put:
description: 'Update a retention filter from your organization.
Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor)
@@ -25948,10 +26426,15 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a retention filter
tags:
- APM Retention Filters
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_retention_filter_write
+ - apm_pipelines_write
/api/v2/application_keys:
get:
description: List all application keys available for your org
operationId: ListApplicationKeys
parameters:
@@ -25990,10 +26473,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all application keys
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - org_app_keys_read
/api/v2/application_keys/{app_key_id}:
delete:
description: Delete an application key
operationId: DeleteApplicationKey
parameters:
@@ -26017,10 +26504,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete an application key
tags:
- Key Management
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - org_app_keys_write
get:
description: Get an application key for your org.
operationId: GetApplicationKey
parameters:
- $ref: '#/components/parameters/ApplicationKeyID'
@@ -26053,10 +26544,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get an application key
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - org_app_keys_read
patch:
description: Edit an application key
operationId: UpdateApplicationKey
parameters:
- $ref: '#/components/parameters/ApplicationKeyID'
@@ -26095,10 +26590,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Edit an application key
tags:
- Key Management
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - org_app_keys_write
/api/v2/audit/events:
get:
description: 'List endpoint returns events that match a Audit Logs search query.
[Results are paginated][1].
@@ -26176,10 +26675,14 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - audit_logs_read
/api/v2/audit/events/search:
post:
description: 'List endpoint returns Audit Logs events that match an Audit search
query.
@@ -26217,10 +26720,14 @@
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - audit_logs_read
/api/v2/authn_mappings:
get:
description: List all AuthN Mappings in the org.
operationId: ListAuthNMappings
parameters:
@@ -26259,10 +26766,13 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List all AuthN Mappings
tags:
- AuthN Mappings
+ x-permission:
+ operator: OPEN
+ permissions: []
post:
description: Create an AuthN Mapping.
operationId: CreateAuthNMapping
requestBody:
content:
@@ -26299,10 +26809,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create an AuthN Mapping
tags:
- AuthN Mappings
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
/api/v2/authn_mappings/{authn_mapping_id}:
delete:
description: Delete an AuthN Mapping specified by AuthN Mapping UUID.
operationId: DeleteAuthNMapping
parameters:
@@ -26322,18 +26836,17 @@
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
- security:
- - apiKeyAuth: []
- appKeyAuth: []
- - AuthZ:
- - user_access_manage
summary: Delete an AuthN Mapping
tags:
- AuthN Mappings
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
get:
description: Get an AuthN Mapping specified by the AuthN Mapping UUID.
operationId: GetAuthNMapping
parameters:
- $ref: '#/components/parameters/AuthNMappingID'
@@ -26356,17 +26869,16 @@
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
- security:
- - apiKeyAuth: []
- appKeyAuth: []
- - AuthZ: []
summary: Get an AuthN Mapping by UUID
tags:
- AuthN Mappings
+ x-permission:
+ operator: OPEN
+ permissions: []
patch:
description: Edit an AuthN Mapping.
operationId: UpdateAuthNMapping
parameters:
- $ref: '#/components/parameters/AuthNMappingID'
@@ -26413,19 +26925,18 @@
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
- security:
- - apiKeyAuth: []
- appKeyAuth: []
- - AuthZ:
- - user_access_manage
summary: Edit an AuthN Mapping
tags:
- AuthN Mappings
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
/api/v2/cases:
get:
description: Search cases.
operationId: SearchCases
parameters:
@@ -27101,10 +27612,14 @@
- ci_visibility_read
summary: Aggregate pipelines events
tags:
- CI Visibility Pipelines
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - ci_visibility_read
/api/v2/ci/pipelines/events:
get:
description: 'List endpoint returns CI Visibility pipeline events that match
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
@@ -27185,10 +27700,14 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - ci_visibility_read
/api/v2/ci/pipelines/events/search:
post:
description: 'List endpoint returns CI Visibility pipeline events that match
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
@@ -27228,10 +27747,14 @@
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - ci_visibility_read
/api/v2/ci/tests/analytics/aggregate:
post:
description: The API endpoint to aggregate CI Visibility test events into buckets
of computed metrics and timeseries.
operationId: AggregateCIAppTestEvents
@@ -27261,10 +27784,14 @@
- ci_visibility_read
summary: Aggregate tests events
tags:
- CI Visibility Tests
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - ci_visibility_read
/api/v2/ci/tests/events:
get:
description: 'List endpoint returns CI Visibility test events that match a [search
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
@@ -27345,10 +27872,14 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - ci_visibility_read
/api/v2/ci/tests/events/search:
post:
description: 'List endpoint returns CI Visibility test events that match a [search
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
@@ -27388,10 +27919,14 @@
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - ci_visibility_read
/api/v2/container_images:
get:
description: Get all Container Images for your organization.
operationId: ListContainerImages
parameters:
@@ -27465,10 +28000,13 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.pagination.next_cursor
limitParam: page[size]
resultsPath: data
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/containers:
get:
description: Get all containers for your organization.
operationId: ListContainers
parameters:
@@ -27542,10 +28080,13 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.pagination.next_cursor
limitParam: page[size]
resultsPath: data
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/cost/aws_cur_config:
get:
description: List the AWS CUR configs.
operationId: ListCostAWSCURConfigs
responses:
@@ -27569,10 +28110,14 @@
- AuthZ:
- cloud_cost_management_read
summary: List Cloud Cost Management AWS CUR configs
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_read
post:
description: Create a Cloud Cost Management account for an AWS CUR config.
operationId: CreateCostAWSCURConfig
requestBody:
content:
@@ -27607,10 +28152,14 @@
- AuthZ:
- cloud_cost_management_write
summary: Create Cloud Cost Management AWS CUR config
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_write
/api/v2/cost/aws_cur_config/{cloud_account_id}:
delete:
description: Archive a Cloud Cost Management Account.
operationId: DeleteCostAWSCURConfig
parameters:
@@ -27638,10 +28187,14 @@
- AuthZ:
- cloud_cost_management_write
summary: Delete Cloud Cost Management AWS CUR config
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_write
patch:
description: Update the status of an AWS CUR config (active/archived).
operationId: UpdateCostAWSCURConfig
parameters:
- $ref: '#/components/parameters/CloudAccountID'
@@ -27672,10 +28225,14 @@
- AuthZ:
- cloud_cost_management_write
summary: Update Cloud Cost Management AWS CUR config
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_write
/api/v2/cost/aws_related_accounts:
get:
deprecated: true
description: List the AWS accounts in an organization by calling 'organizations:ListAccounts'
from the specified management account.
@@ -27715,10 +28272,14 @@
- AuthZ:
- cloud_cost_management_read
summary: List related AWS accounts
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_read
/api/v2/cost/azure_uc_config:
get:
description: List the Azure configs.
operationId: ListCostAzureUCConfigs
responses:
@@ -27742,10 +28303,14 @@
- AuthZ:
- cloud_cost_management_read
summary: List Cloud Cost Management Azure configs
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_read
post:
description: Create a Cloud Cost Management account for an Azure config.
operationId: CreateCostAzureUCConfigs
requestBody:
content:
@@ -27780,10 +28345,14 @@
- AuthZ:
- cloud_cost_management_write
summary: Create Cloud Cost Management Azure configs
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_write
/api/v2/cost/azure_uc_config/{cloud_account_id}:
delete:
description: Archive a Cloud Cost Management Account.
operationId: DeleteCostAzureUCConfig
parameters:
@@ -27811,10 +28380,14 @@
- AuthZ:
- cloud_cost_management_write
summary: Delete Cloud Cost Management Azure config
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_write
patch:
description: Update the status of an Azure config (active/archived).
operationId: UpdateCostAzureUCConfigs
parameters:
- $ref: '#/components/parameters/CloudAccountID'
@@ -27851,10 +28424,14 @@
- AuthZ:
- cloud_cost_management_write
summary: Update Cloud Cost Management Azure config
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_write
/api/v2/cost/custom_costs:
get:
description: List the Custom Costs files.
operationId: ListCustomCostsFiles
responses:
@@ -27990,10 +28567,14 @@
- AuthZ:
- cloud_cost_management_read
summary: Cloud Cost Enabled
tags:
- Cloud Cost Management
+ x-permission:
+ operator: OR
+ permissions:
+ - cloud_cost_management_read
/api/v2/cost_by_tag/active_billing_dimensions:
get:
description: Get active billing dimensions for cost attribution. Cost data for
a given month becomes available no later than the 19th of the following month.
operationId: GetActiveBillingDimensions
@@ -28028,10 +28609,14 @@
- AuthZ:
- usage_read
summary: Get active billing dimensions for cost attribution
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/cost_by_tag/monthly_cost_attribution:
get:
@@ -28151,10 +28736,14 @@
- AuthZ:
- usage_read
summary: Get Monthly Cost Attribution
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/current_user/application_keys:
get:
@@ -28196,10 +28785,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all application keys owned by current user
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - user_app_keys
post:
description: Create an application key for current user
operationId: CreateCurrentUserApplicationKey
requestBody:
content:
@@ -28230,10 +28823,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create an application key for current user
tags:
- Key Management
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_app_keys
/api/v2/current_user/application_keys/{app_key_id}:
delete:
description: Delete an application key owned by current user
operationId: DeleteCurrentUserApplicationKey
parameters:
@@ -28256,10 +28853,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete an application key owned by current user
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - user_app_keys
get:
description: Get an application key owned by current user
operationId: GetCurrentUserApplicationKey
parameters:
- $ref: '#/components/parameters/ApplicationKeyID'
@@ -28285,10 +28886,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get one application key owned by current user
tags:
- Key Management
+ x-permission:
+ operator: OR
+ permissions:
+ - user_app_keys
patch:
description: Edit an application key owned by current user
operationId: UpdateCurrentUserApplicationKey
parameters:
- $ref: '#/components/parameters/ApplicationKeyID'
@@ -28327,10 +28932,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Edit an application key owned by current user
tags:
- Key Management
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_app_keys
/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards:
delete:
description: Delete dashboards from an existing dashboard list.
operationId: DeleteDashboardListItems
parameters:
@@ -28417,10 +29026,14 @@
- AuthZ:
- dashboards_read
summary: Get items of a Dashboard List
tags:
- Dashboard Lists
+ x-permission:
+ operator: OR
+ permissions:
+ - dashboards_read
post:
description: Add dashboards to an existing dashboard list.
operationId: CreateDashboardListItems
parameters:
- description: ID of the dashboard list to add items to.
@@ -28675,10 +29288,14 @@
- Downtimes
x-pagination:
limitParam: page[limit]
pageOffsetParam: page[offset]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_downtime
post:
description: Schedule a downtime.
operationId: CreateDowntime
requestBody:
content:
@@ -28715,10 +29332,14 @@
- monitors_downtime
summary: Schedule a downtime
tags:
- Downtimes
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_downtime
/api/v2/downtime/{downtime_id}:
delete:
description: Cancel a downtime.
operationId: CancelDowntime
parameters:
@@ -28752,10 +29373,14 @@
- AuthZ:
- monitors_downtime
summary: Cancel a downtime
tags:
- Downtimes
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_downtime
get:
description: Get downtime detail by `downtime_id`.
operationId: GetDowntime
parameters:
- description: ID of the downtime to fetch.
@@ -28808,10 +29433,14 @@
- AuthZ:
- monitors_downtime
summary: Get a downtime
tags:
- Downtimes
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_downtime
patch:
description: Update a downtime by `downtime_id`.
operationId: UpdateDowntime
parameters:
- description: ID of the downtime to update.
@@ -28862,10 +29491,14 @@
- monitors_downtime
summary: Update a downtime
tags:
- Downtimes
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_downtime
/api/v2/events:
get:
description: 'List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
@@ -28940,10 +29573,14 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - events_read
/api/v2/events/search:
post:
description: 'List endpoint returns events that match an events search query.
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
@@ -28977,10 +29614,14 @@
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - events_read
/api/v2/incidents:
get:
description: Get all incidents for the user's organization.
operationId: ListIncidents
parameters:
@@ -29014,10 +29655,14 @@
- Incidents
x-pagination:
limitParam: page[size]
pageOffsetParam: page[offset]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
post:
description: Create an incident.
@@ -29053,10 +29698,14 @@
- incident_write
summary: Create an incident
tags:
- Incidents
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/search:
get:
@@ -29095,10 +29744,14 @@
- Incidents
x-pagination:
limitParam: page[size]
pageOffsetParam: page[offset]
resultsPath: data.attributes.incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}:
delete:
@@ -29125,10 +29778,14 @@
- AuthZ:
- incident_write
summary: Delete an existing incident
tags:
- Incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
get:
description: Get the details of an incident by `incident_id`.
@@ -29159,10 +29816,14 @@
- AuthZ:
- incident_read
summary: Get the details of an incident
tags:
- Incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
patch:
description: Updates an incident. Provide only the attributes that should be
@@ -29202,10 +29863,14 @@
- incident_write
summary: Update an existing incident
tags:
- Incidents
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}/attachments:
get:
@@ -29230,18 +29895,17 @@
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
- security:
- - apiKeyAuth: []
- appKeyAuth: []
- - AuthZ:
- - incident_read
summary: Get a list of attachments
tags:
- Incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
patch:
description: The bulk update endpoint for creating, updating, and deleting attachments
@@ -29276,10 +29940,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create, update, and delete incident attachments
tags:
- Incidents
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}/relationships/integrations:
get:
@@ -29310,10 +29978,14 @@
- AuthZ:
- incident_read
summary: Get a list of an incident's integration metadata
tags:
- Incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
post:
description: Create an incident integration metadata.
@@ -29351,10 +30023,14 @@
- incident_write
summary: Create an incident integration metadata
tags:
- Incidents
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}:
delete:
@@ -29493,10 +30169,14 @@
- AuthZ:
- incident_read
summary: Get a list of an incident's todos
tags:
- Incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
post:
description: Create an incident todo.
@@ -29534,10 +30214,14 @@
- incident_write
summary: Create an incident todo
tags:
- Incidents
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}/relationships/todos/{todo_id}:
delete:
@@ -29565,10 +30249,14 @@
- AuthZ:
- incident_write
summary: Delete an incident todo
tags:
- Incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
get:
description: Get incident todo details.
@@ -29599,10 +30287,14 @@
- AuthZ:
- incident_read
summary: Get incident todo details
tags:
- Incidents
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
patch:
description: Update an incident todo.
@@ -29641,10 +30333,14 @@
- incident_write
summary: Update an incident todo
tags:
- Incidents
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_write
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/integration/gcp/accounts:
get:
@@ -29665,10 +30361,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List all GCP STS-enabled service accounts
tags:
- GCP Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - gcp_configuration_read
post:
description: Create a new entry within Datadog for your STS enabled service
account.
operationId: CreateGCPSTSAccount
requestBody:
@@ -29696,10 +30396,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a new entry for your service account
tags:
- GCP Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - gcp_configurations_manage
/api/v2/integration/gcp/accounts/{account_id}:
delete:
description: Delete an STS enabled GCP account from within Datadog.
operationId: DeleteGCPSTSAccount
parameters:
@@ -29714,10 +30418,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete an STS enabled GCP Account
tags:
- GCP Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - gcp_configurations_manage
patch:
description: Update an STS enabled service account.
operationId: UpdateGCPSTSAccount
parameters:
- $ref: '#/components/parameters/GCPSTSServiceAccountID'
@@ -29744,10 +30452,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update STS Service Account
tags:
- GCP Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - gcp_configuration_edit
/api/v2/integration/gcp/sts_delegate:
get:
description: List your Datadog-GCP STS delegate account configured in your Datadog
account.
operationId: GetGCPSTSDelegate
@@ -29764,10 +30476,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List delegate account
tags:
- GCP Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - gcp_configuration_read
post:
description: Create a Datadog GCP principal.
operationId: MakeGCPSTSDelegate
requestBody:
content:
@@ -29792,10 +30508,208 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a Datadog GCP principal
tags:
- GCP Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - gcp_configuration_edit
+ /api/v2/integration/ms-teams/configuration/channel/{tenant_name}/{team_name}/{channel_name}:
+ get:
+ description: Get the tenant, team, and channel ID of a channel in the Datadog
+ Microsoft Teams integration.
+ operationId: GetChannelByName
+ parameters:
+ - $ref: '#/components/parameters/MicrosoftTeamsTenantNamePathParameter'
+ - $ref: '#/components/parameters/MicrosoftTeamsTeamNamePathParameter'
+ - $ref: '#/components/parameters/MicrosoftTeamsChannelNamePathParameter'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsGetChannelByNameResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get channel information by name
+ tags:
+ - Microsoft Teams Integration
+ /api/v2/integration/ms-teams/configuration/tenant-based-handles:
+ get:
+ description: Get a list of all handles from the Datadog Microsoft Teams integration.
+ operationId: ListApiHandles
+ parameters:
+ - $ref: '#/components/parameters/MicrosoftTeamsTenantIDQueryParameter'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandlesResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '412':
+ $ref: '#/components/responses/PreconditionFailedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get all handles
+ tags:
+ - Microsoft Teams Integration
+ post:
+ description: Create a handle in the Datadog Microsoft Teams integration.
+ operationId: CreateApiHandle
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsCreateApiHandleRequest'
+ description: Handle payload.
+ required: true
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsCreateApiHandleResponse'
+ description: CREATED
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '409':
+ $ref: '#/components/responses/ConflictResponse'
+ '412':
+ $ref: '#/components/responses/PreconditionFailedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Create handle
+ tags:
+ - Microsoft Teams Integration
+ x-codegen-request-body-name: body
+ /api/v2/integration/ms-teams/configuration/tenant-based-handles/name/{handle_name}:
+ get:
+ description: Get the tenant, team, and channel information of a handle by name
+ from the Datadog Microsoft Teams integration.
+ operationId: GetApiHandleByName
+ parameters:
+ - $ref: '#/components/parameters/MicrosoftTeamsHandleNamePathParameter'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '412':
+ $ref: '#/components/responses/PreconditionFailedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get handle information by name
+ tags:
+ - Microsoft Teams Integration
+ /api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}:
+ delete:
+ description: Delete a handle from the Datadog Microsoft Teams integration.
+ operationId: DeleteApiHandle
+ parameters:
+ - $ref: '#/components/parameters/MicrosoftTeamsHandleIDPathParameter'
+ responses:
+ '204':
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '412':
+ $ref: '#/components/responses/PreconditionFailedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Delete handle
+ tags:
+ - Microsoft Teams Integration
+ get:
+ description: Get the tenant, team, and channel information of a handle from
+ the Datadog Microsoft Teams integration.
+ operationId: GetApiHandle
+ parameters:
+ - $ref: '#/components/parameters/MicrosoftTeamsHandleIDPathParameter'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '412':
+ $ref: '#/components/responses/PreconditionFailedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get handle information
+ tags:
+ - Microsoft Teams Integration
+ patch:
+ description: Update a handle from the Datadog Microsoft Teams integration.
+ operationId: UpdateApiHandle
+ parameters:
+ - $ref: '#/components/parameters/MicrosoftTeamsHandleIDPathParameter'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsUpdateApiHandleRequest'
+ description: Opsgenie service payload.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '409':
+ $ref: '#/components/responses/ConflictResponse'
+ '412':
+ $ref: '#/components/responses/PreconditionFailedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Update handle
+ tags:
+ - Microsoft Teams Integration
+ x-codegen-request-body-name: body
/api/v2/integration/opsgenie/services:
get:
description: Get a list of all services from the Datadog Opsgenie integration.
operationId: ListOpsgenieServices
responses:
@@ -29810,10 +30724,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all service objects
tags:
- Opsgenie Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
post:
description: Create a new service object in the Opsgenie integration.
operationId: CreateOpsgenieService
requestBody:
content:
@@ -29839,10 +30757,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a new service object
tags:
- Opsgenie Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integration/opsgenie/services/{integration_service_id}:
delete:
description: Delete a single service object in the Datadog Opsgenie integration.
operationId: DeleteOpsgenieService
parameters:
@@ -29859,10 +30781,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a single service object
tags:
- Opsgenie Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
get:
description: Get a single service from the Datadog Opsgenie integration.
operationId: GetOpsgenieService
parameters:
- $ref: '#/components/parameters/OpsgenieServiceIDPathParameter'
@@ -29884,10 +30810,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a single service object
tags:
- Opsgenie Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
patch:
description: Update a single service object in the Datadog Opsgenie integration.
operationId: UpdateOpsgenieService
parameters:
- $ref: '#/components/parameters/OpsgenieServiceIDPathParameter'
@@ -29917,10 +30847,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a single service object
tags:
- Opsgenie Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/cloudflare/accounts:
get:
description: List Cloudflare accounts.
operationId: ListCloudflareAccounts
responses:
@@ -29939,10 +30873,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List Cloudflare accounts
tags:
- Cloudflare Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
post:
description: Create a Cloudflare account.
operationId: CreateCloudflareAccount
requestBody:
content:
@@ -29967,10 +30905,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Add Cloudflare account
tags:
- Cloudflare Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/cloudflare/accounts/{account_id}:
delete:
description: Delete a Cloudflare account.
operationId: DeleteCloudflareAccount
parameters:
@@ -29992,10 +30934,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete Cloudflare account
tags:
- Cloudflare Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
get:
description: Get a Cloudflare account.
operationId: GetCloudflareAccount
parameters:
- description: None
@@ -30020,10 +30966,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get Cloudflare account
tags:
- Cloudflare Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
patch:
description: Update a Cloudflare account.
operationId: UpdateCloudflareAccount
parameters:
- description: None
@@ -30055,10 +31005,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update Cloudflare account
tags:
- Cloudflare Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/confluent-cloud/accounts:
get:
description: List Confluent accounts.
operationId: ListConfluentAccount
responses:
@@ -30077,10 +31031,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List Confluent accounts
tags:
- Confluent Cloud
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
post:
description: Create a Confluent account.
operationId: CreateConfluentAccount
requestBody:
content:
@@ -30106,10 +31064,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Add Confluent account
tags:
- Confluent Cloud
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/confluent-cloud/accounts/{account_id}:
delete:
description: Delete a Confluent account with the provided account ID.
operationId: DeleteConfluentAccount
parameters:
@@ -30126,10 +31088,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete Confluent account
tags:
- Confluent Cloud
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
get:
description: Get the Confluent account with the provided account ID.
operationId: GetConfluentAccount
parameters:
- $ref: '#/components/parameters/ConfluentAccountID'
@@ -30149,10 +31115,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get Confluent account
tags:
- Confluent Cloud
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
patch:
description: Update the Confluent account with the provided account ID.
operationId: UpdateConfluentAccount
parameters:
- $ref: '#/components/parameters/ConfluentAccountID'
@@ -30180,10 +31150,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update Confluent account
tags:
- Confluent Cloud
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources:
get:
description: Get a Confluent resource for the account associated with the provided
ID.
operationId: ListConfluentResource
@@ -30205,10 +31179,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List Confluent Account resources
tags:
- Confluent Cloud
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
post:
description: Create a Confluent resource for the account associated with the
provided ID.
operationId: CreateConfluentResource
parameters:
@@ -30237,10 +31215,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Add resource to Confluent account
tags:
- Confluent Cloud
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}:
delete:
description: Delete a Confluent resource with the provided resource id for the
account associated with the provided account ID.
operationId: DeleteConfluentResource
@@ -30259,10 +31241,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete resource from Confluent account
tags:
- Confluent Cloud
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
get:
description: Get a Confluent resource with the provided resource id for the
account associated with the provided account ID.
operationId: GetConfluentResource
parameters:
@@ -30284,10 +31270,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get resource from Confluent account
tags:
- Confluent Cloud
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
patch:
description: Update a Confluent resource with the provided resource id for the
account associated with the provided account ID.
operationId: UpdateConfluentResource
parameters:
@@ -30317,10 +31307,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update resource in Confluent account
tags:
- Confluent Cloud
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/fastly/accounts:
get:
description: List Fastly accounts.
operationId: ListFastlyAccounts
responses:
@@ -30339,10 +31333,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List Fastly accounts
tags:
- Fastly Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
post:
description: Create a Fastly account.
operationId: CreateFastlyAccount
requestBody:
content:
@@ -30367,10 +31365,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Add Fastly account
tags:
- Fastly Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/fastly/accounts/{account_id}:
delete:
description: Delete a Fastly account.
operationId: DeleteFastlyAccount
parameters:
@@ -30387,10 +31389,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete Fastly account
tags:
- Fastly Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
get:
description: Get a Fastly account.
operationId: GetFastlyAccount
parameters:
- $ref: '#/components/parameters/FastlyAccountID'
@@ -30410,10 +31416,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get Fastly account
tags:
- Fastly Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
patch:
description: Update a Fastly account.
operationId: UpdateFastlyAccount
parameters:
- $ref: '#/components/parameters/FastlyAccountID'
@@ -30440,10 +31450,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update Fastly account
tags:
- Fastly Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/fastly/accounts/{account_id}/services:
get:
description: List Fastly services for an account.
operationId: ListFastlyServices
parameters:
@@ -30464,10 +31478,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List Fastly services
tags:
- Fastly Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
post:
description: Create a Fastly service for an account.
operationId: CreateFastlyService
parameters:
- $ref: '#/components/parameters/FastlyAccountID'
@@ -30494,10 +31512,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Add Fastly service
tags:
- Fastly Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/fastly/accounts/{account_id}/services/{service_id}:
delete:
description: Delete a Fastly service for an account.
operationId: DeleteFastlyService
parameters:
@@ -30515,10 +31537,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete Fastly service
tags:
- Fastly Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
get:
description: Get a Fastly service for an account.
operationId: GetFastlyService
parameters:
- $ref: '#/components/parameters/FastlyAccountID'
@@ -30539,10 +31565,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get Fastly service
tags:
- Fastly Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
patch:
description: Update a Fastly service for an account.
operationId: UpdateFastlyService
parameters:
- $ref: '#/components/parameters/FastlyAccountID'
@@ -30570,10 +31600,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update Fastly service
tags:
- Fastly Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/okta/accounts:
get:
description: List Okta accounts.
operationId: ListOktaAccounts
responses:
@@ -30592,10 +31626,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List Okta accounts
tags:
- Okta Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
post:
description: Create an Okta account.
operationId: CreateOktaAccount
requestBody:
content:
@@ -30620,10 +31658,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Add Okta account
tags:
- Okta Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/integrations/okta/accounts/{account_id}:
delete:
description: Delete an Okta account.
operationId: DeleteOktaAccount
parameters:
@@ -30645,10 +31687,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete Okta account
tags:
- Okta Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
get:
description: Get an Okta account.
operationId: GetOktaAccount
parameters:
- description: None
@@ -30673,10 +31719,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get Okta account
tags:
- Okta Integration
+ x-permission:
+ operator: OR
+ permissions:
+ - integrations_read
patch:
description: Update an Okta account.
operationId: UpdateOktaAccount
parameters:
- description: None
@@ -30708,10 +31758,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update Okta account
tags:
- Okta Integration
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - manage_integrations
/api/v2/ip_allowlist:
get:
description: Returns the IP allowlist and its enabled or disabled state.
operationId: GetIPAllowlist
responses:
@@ -30733,10 +31787,14 @@
- AuthZ:
- org_management
summary: Get IP Allowlist
tags:
- IP Allowlist
+ x-permission:
+ operator: OR
+ permissions:
+ - org_management
patch:
description: Edit the entries in the IP allowlist, and enable or disable it.
operationId: UpdateIPAllowlist
requestBody:
content:
@@ -30766,10 +31824,14 @@
- org_management
summary: Update IP Allowlist
tags:
- IP Allowlist
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - org_management
/api/v2/logs:
post:
description: 'Send your logs to your Datadog platform over HTTP. Limits per
HTTP request are:
@@ -31021,10 +32083,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Aggregate events
tags:
- Logs
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_read_data
/api/v2/logs/config/archive-order:
get:
description: 'Get the current order of your archives.
This endpoint takes no JSON arguments.'
@@ -31045,10 +32111,13 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get archive order
tags:
- Logs Archives
+ x-permission:
+ operator: OPEN
+ permissions: []
put:
description: 'Update the order of your archives. Since logs are processed sequentially,
reordering an archive may change
the structure and content of the data processed by other archives.
@@ -31095,10 +32164,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update archive order
tags:
- Logs Archives
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_archives
/api/v2/logs/config/archives:
get:
description: Get the list of configured logs archives with their definitions.
operationId: ListLogsArchives
responses:
@@ -31117,10 +32190,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all archives
tags:
- Logs Archives
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_read_archives
post:
description: Create an archive in your organization.
operationId: CreateLogsArchive
requestBody:
content:
@@ -31152,10 +32229,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create an archive
tags:
- Logs Archives
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_archives
/api/v2/logs/config/archives/{archive_id}:
delete:
description: Delete a given archive from your organization.
operationId: DeleteLogsArchive
parameters:
@@ -31184,10 +32265,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete an archive
tags:
- Logs Archives
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_archives
get:
description: Get a specific archive from your organization.
operationId: GetLogsArchive
parameters:
- $ref: '#/components/parameters/ArchiveID'
@@ -31219,10 +32304,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get an archive
tags:
- Logs Archives
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_read_archives
put:
description: 'Update a given archive configuration.
**Note**: Using this method updates your archive configuration by **replacing**
@@ -31267,10 +32356,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update an archive
tags:
- Logs Archives
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_archives
/api/v2/logs/config/archives/{archive_id}/readers:
delete:
description: Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
operationId: RemoveRoleFromArchive
parameters:
@@ -31306,10 +32399,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Revoke role from an archive
tags:
- Logs Archives
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_archives
get:
description: Returns all read roles a given archive is restricted to.
operationId: ListArchiveReadRoles
parameters:
- $ref: '#/components/parameters/ArchiveID'
@@ -31342,10 +32439,13 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List read roles for an archive
tags:
- Logs Archives
x-codegen-request-body-name: body
+ x-permission:
+ operator: OPEN
+ permissions: []
post:
description: Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
operationId: AddReadRoleToArchive
parameters:
- $ref: '#/components/parameters/ArchiveID'
@@ -31380,10 +32480,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Grant role to an archive
tags:
- Logs Archives
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_archives
/api/v2/logs/config/custom-destinations:
get:
description: Get the list of configured custom destinations in your organization
with their definitions.
operationId: ListLogsCustomDestinations
@@ -31403,10 +32507,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all custom destinations
tags:
- Logs Custom Destinations
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_read_data
post:
description: Create a custom destination in your organization.
operationId: CreateLogsCustomDestination
requestBody:
content:
@@ -31432,10 +32540,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a custom destination
tags:
- Logs Custom Destinations
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_forwarding_rules
/api/v2/logs/config/custom-destinations/{custom_destination_id}:
delete:
description: Delete a specific custom destination in your organization.
operationId: DeleteLogsCustomDestination
parameters:
@@ -31452,10 +32564,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a custom destination
tags:
- Logs Custom Destinations
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_forwarding_rules
get:
description: Get a specific custom destination in your organization.
operationId: GetLogsCustomDestination
parameters:
- $ref: '#/components/parameters/CustomDestinationId'
@@ -31475,10 +32591,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a custom destination
tags:
- Logs Custom Destinations
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_read_data
patch:
description: Update the given fields of a specific custom destination in your
organization.
operationId: UpdateLogsCustomDestination
parameters:
@@ -31509,10 +32629,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a custom destination
tags:
- Logs Custom Destinations
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_write_forwarding_rules
/api/v2/logs/config/metrics:
get:
description: Get the list of configured log-based metrics with their definitions.
operationId: ListLogsMetrics
responses:
@@ -31527,10 +32651,13 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all log-based metrics
tags:
- Logs Metrics
+ x-permission:
+ operator: OPEN
+ permissions: []
post:
description: 'Create a metric based on your ingested logs in your organization.
Returns the log-based metric object from the request body when the request
is successful.'
@@ -31559,10 +32686,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a log-based metric
tags:
- Logs Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_generate_metrics
/api/v2/logs/config/metrics/{metric_id}:
delete:
description: Delete a specific log-based metric from your organization.
operationId: DeleteLogsMetric
parameters:
@@ -31577,10 +32708,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a log-based metric
tags:
- Logs Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_generate_metrics
get:
description: Get a specific log-based metric from your organization.
operationId: GetLogsMetric
parameters:
- $ref: '#/components/parameters/MetricID'
@@ -31598,10 +32733,13 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a log-based metric
tags:
- Logs Metrics
+ x-permission:
+ operator: OPEN
+ permissions: []
patch:
description: 'Update a specific log-based metric from your organization.
Returns the log-based metric object from the request body when the request
is successful.'
@@ -31632,10 +32770,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a log-based metric
tags:
- Logs Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_generate_metrics
/api/v2/logs/events:
get:
description: 'List endpoint returns logs that match a log search query.
[Results are paginated][1].
@@ -31744,10 +32886,14 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_read_data
/api/v2/logs/events/search:
post:
description: 'List endpoint returns logs that match a log search query.
[Results are paginated][1].
@@ -31793,10 +32939,14 @@
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - logs_read_data
/api/v2/metrics:
get:
description: "Returns all metrics that can be configured in the Metrics Summary
page or with Metrics without Limits\u2122 (matching additional filters if
specified)."
@@ -31820,11 +32970,11 @@
- description: Filter metrics by metric type.
in: query
name: filter[metric_type]
required: false
schema:
- $ref: '#/components/schemas/MetricTagConfigurationMetricTypes'
+ $ref: '#/components/schemas/MetricTagConfigurationMetricTypeCategory'
- description: 'Filter distributions with additional percentile
aggregations enabled or disabled.'
example: true
in: query
@@ -31895,10 +33045,14 @@
- AuthZ:
- metrics_read
summary: Get a list of metrics
tags:
- Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - metrics_read
/api/v2/metrics/config/bulk-tags:
delete:
description: 'Delete all custom lists of queryable tag keys for a set of existing
count, gauge, rate, and distribution metrics.
@@ -31949,10 +33103,14 @@
description: Too Many Requests
summary: Delete tags for multiple metrics
tags:
- Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - metric_tags_write
post:
description: 'Create and define a list of queryable tag keys for a set of existing
count, gauge, rate, and distribution metrics.
Metrics are selected by passing a metric name prefix. Use the Delete method
@@ -32012,10 +33170,14 @@
description: Too Many Requests
summary: Configure tags for multiple metrics
tags:
- Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - metric_tags_write
/api/v2/metrics/{metric_name}/active-configurations:
get:
description: List tags and aggregations that are actively queried on dashboards,
notebooks, monitors, and the Metrics Explorer for a given metric name.
operationId: ListActiveMetricConfigurations
@@ -32064,10 +33226,14 @@
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: List active tags and aggregations
tags:
- Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - metrics_read
/api/v2/metrics/{metric_name}/all-tags:
get:
description: View indexed tag key-value pairs for a given metric name.
operationId: ListTagsByMetricName
parameters:
@@ -32109,10 +33275,14 @@
- AuthZ:
- metrics_read
summary: List tags by metric name
tags:
- Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - metrics_read
/api/v2/metrics/{metric_name}/assets:
get:
description: Returns dashboards, monitors, notebooks, and SLOs that a metric
is stored in, if any. Updated every 24 hours.
operationId: ListMetricAssets
@@ -32170,12 +33340,11 @@
name: filter[groups]
required: false
schema:
type: string
- description: The number of hours of look back (from now) to estimate cardinality
- with. Estimates are based on historical data, and unspecified fields default
- to the minimum 49 hours.
+ with. If unspecified, it defaults to 0 hours.
example: 49
in: query
name: filter[hours_ago]
required: false
schema:
@@ -32200,11 +33369,11 @@
name: filter[pct]
required: false
schema:
type: boolean
- description: A window, in hours, from the look back to estimate cardinality
- with.
+ with. The minimum and default is 1 hour.
example: 6
in: query
name: filter[timespan_h]
required: false
schema:
@@ -32243,10 +33412,13 @@
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Tag Configuration Cardinality Estimator
tags:
- Metrics
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/metrics/{metric_name}/tags:
delete:
description: 'Deletes a metric''s tag configuration. Can only be used with application
keys from users with the `Manage Tags for Metrics` permission.'
@@ -32275,10 +33447,14 @@
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Delete a tag configuration
tags:
- Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - metric_tags_write
get:
description: Returns the tag configuration for the given metric name.
operationId: ListTagConfigurationByName
parameters:
- $ref: '#/components/parameters/MetricName'
@@ -32313,10 +33489,14 @@
- AuthZ:
- metrics_read
summary: List tag configuration by name
tags:
- Metrics
+ x-permission:
+ operator: OR
+ permissions:
+ - metrics_read
patch:
description: 'Update the tag configuration of a metric or percentile aggregations
of a distribution metric or custom aggregations
of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true
@@ -32371,10 +33551,14 @@
description: Too Many Requests
summary: Update a tag configuration
tags:
- Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - metric_tags_write
post:
description: 'Create and define a list of queryable tag keys for an existing
count/gauge/rate/distribution metric.
Optionally, include percentile aggregations on any distribution metric or
@@ -32430,10 +33614,14 @@
description: Too Many Requests
summary: Create a tag configuration
tags:
- Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - metric_tags_write
/api/v2/metrics/{metric_name}/volumes:
get:
description: 'View distinct metrics volumes for the given metric name.
@@ -32474,10 +33662,13 @@
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: List distinct metric volumes by metric name
tags:
- Metrics
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/monitor/policy:
get:
description: Get all monitor configuration policies.
operationId: ListMonitorConfigPolicies
responses:
@@ -32501,10 +33692,14 @@
- AuthZ:
- monitors_read
summary: Get all monitor configuration policies
tags:
- Monitors
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_read
post:
description: Create a monitor configuration policy.
operationId: CreateMonitorConfigPolicy
requestBody:
content:
@@ -32536,10 +33731,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a monitor configuration policy
tags:
- Monitors
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - monitor_config_policy_write
/api/v2/monitor/policy/{policy_id}:
delete:
description: Delete a monitor configuration policy.
operationId: DeleteMonitorConfigPolicy
parameters:
@@ -32574,10 +33773,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a monitor configuration policy
tags:
- Monitors
+ x-permission:
+ operator: OR
+ permissions:
+ - monitor_config_policy_write
get:
description: Get a monitor configuration policy by `policy_id`.
operationId: GetMonitorConfigPolicy
parameters:
- description: ID of the monitor configuration policy.
@@ -32614,10 +33817,14 @@
- AuthZ:
- monitors_read
summary: Get a monitor configuration policy
tags:
- Monitors
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_read
patch:
description: Edit a monitor configuration policy.
operationId: UpdateMonitorConfigPolicy
parameters:
- description: ID of the monitor configuration policy.
@@ -32663,10 +33870,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Edit a monitor configuration policy
tags:
- Monitors
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - monitor_config_policy_write
/api/v2/monitor/{monitor_id}/downtime_matches:
get:
description: Get all active downtimes for the specified monitor.
operationId: ListMonitorDowntimes
parameters:
@@ -32713,10 +33924,14 @@
x-codegen-request-body-name: body
x-pagination:
limitParam: page[limit]
pageOffsetParam: page[offset]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - monitors_downtime
/api/v2/ndm/devices:
get:
description: Get the list of devices.
operationId: ListDevices
parameters:
@@ -32898,16 +34113,16 @@
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
- security:
- - apiKeyAuth: []
- appKeyAuth: []
summary: List Org Configs
tags:
- Organizations
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/org_configs/{org_config_name}:
get:
description: Return the name, description, and value of a specific Org Config.
operationId: GetOrgConfig
parameters:
@@ -32927,16 +34142,16 @@
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
- security:
- - apiKeyAuth: []
- appKeyAuth: []
summary: Get a specific Org Config value
tags:
- Organizations
+ x-permission:
+ operator: OPEN
+ permissions: []
patch:
description: Update the value of a specific Org Config.
operationId: UpdateOrgConfig
parameters:
- $ref: '#/components/parameters/OrgConfigName'
@@ -32964,10 +34179,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a specific Org Config
tags:
- Organizations
+ x-permission:
+ operator: OR
+ permissions:
+ - org_management
/api/v2/permissions:
get:
description: Returns a list of all permissions, including name, description,
and ID.
operationId: ListPermissions
@@ -33274,10 +34493,14 @@
- Powerpack
x-pagination:
limitParam: page[limit]
pageOffsetParam: page[offset]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - dashboards_read
post:
description: Create a powerpack.
operationId: CreatePowerpack
requestBody:
content:
@@ -33308,10 +34531,14 @@
- dashboards_write
summary: Create a new powerpack
tags:
- Powerpack
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - dashboards_write
/api/v2/powerpacks/{powerpack_id}:
delete:
description: Delete a powerpack.
operationId: DeletePowerpack
parameters:
@@ -33338,10 +34565,14 @@
- AuthZ:
- dashboards_write
summary: Delete a powerpack
tags:
- Powerpack
+ x-permission:
+ operator: OR
+ permissions:
+ - dashboards_write
get:
description: Get a powerpack.
operationId: GetPowerpack
parameters:
- description: ID of the powerpack.
@@ -33371,10 +34602,14 @@
- AuthZ:
- dashboards_read
summary: Get a Powerpack
tags:
- Powerpack
+ x-permission:
+ operator: OR
+ permissions:
+ - dashboards_read
patch:
description: Update a powerpack.
operationId: UpdatePowerpack
parameters:
- description: ID of the powerpack.
@@ -33418,10 +34653,14 @@
- dashboards_write
summary: Update a powerpack
tags:
- Powerpack
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - dashboards_write
/api/v2/processes:
get:
description: Get all processes for your organization.
operationId: ListProcesses
parameters:
@@ -33513,10 +34752,13 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/query/scalar:
post:
description: 'Query scalar values (as seen on Query Value, Table, and Toplist
widgets).
@@ -33552,10 +34794,14 @@
- timeseries_query
summary: Query scalar data across multiple products
tags:
- Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - timeseries_query
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
(RUM), Cloud Cost Management, and Log Management data sources.
We are gradually onboarding support for more sources. If you have any
@@ -33594,10 +34840,14 @@
- timeseries_query
summary: Query timeseries data across multiple products
tags:
- Metrics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - timeseries_query
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
(RUM), Cloud Cost Management, and Log Management data sources.
We are gradually onboarding support for more sources. If you have any
@@ -33766,13 +35016,17 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
+ - AuthZ: []
summary: Delete a restriction policy
tags:
- Restriction Policies
+ x-permission:
+ operator: OPEN
+ permissions: []
get:
description: Retrieves the restriction policy associated with a specified resource.
operationId: GetRestrictionPolicy
parameters:
- $ref: '#/components/parameters/ResourceID'
@@ -33790,13 +35044,17 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
+ - AuthZ: []
summary: Get a restriction policy
tags:
- Restriction Policies
+ x-permission:
+ operator: OPEN
+ permissions: []
post:
description: 'Updates the restriction policy associated with a resource.
#### Supported resources
@@ -33869,14 +35127,18 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
+ - AuthZ: []
summary: Update a restriction policy
tags:
- Restriction Policies
x-codegen-request-body-name: body
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/roles:
get:
description: Returns all roles, including their names and their unique identifiers.
operationId: ListRoles
parameters:
@@ -33927,10 +35189,14 @@
- AuthZ:
- user_access_read
summary: List roles
tags:
- Roles
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_read
post:
description: Create a new role for your organization.
operationId: CreateRole
requestBody:
content:
@@ -33966,10 +35232,14 @@
- user_access_manage
summary: Create role
tags:
- Roles
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
/api/v2/roles/{role_id}:
delete:
description: Disables a role.
operationId: DeleteRole
parameters:
@@ -34087,10 +35357,14 @@
- user_access_manage
summary: Update a role
tags:
- Roles
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
/api/v2/roles/{role_id}/clone:
post:
description: Clone an existing role
operationId: CloneRole
parameters:
@@ -34141,10 +35415,14 @@
- user_access_manage
summary: Create a new role by cloning an existing role
tags:
- Roles
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
/api/v2/roles/{role_id}/permissions:
delete:
description: Removes a permission from a role.
operationId: RemovePermissionFromRole
parameters:
@@ -34189,10 +35467,14 @@
- user_access_manage
summary: Revoke permission
tags:
- Roles
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
get:
description: Returns a list of all permissions for a single role.
operationId: ListRolePermissions
parameters:
- $ref: '#/components/parameters/RoleID'
@@ -34271,10 +35553,14 @@
- user_access_manage
summary: Grant permission to a role
tags:
- Roles
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
/api/v2/roles/{role_id}/users:
delete:
description: Removes a user from a role.
operationId: RemoveUserFromRole
parameters:
@@ -34319,10 +35605,14 @@
- user_access_manage
summary: Remove a user from a role
tags:
- Roles
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
get:
description: Gets all users of a role.
operationId: ListRoleUsers
parameters:
- $ref: '#/components/parameters/RoleID'
@@ -34420,10 +35710,14 @@
- user_access_manage
summary: Add a user to a role
tags:
- Roles
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
/api/v2/rum/analytics/aggregate:
post:
description: The API endpoint to aggregate RUM events into buckets of computed
metrics and timeseries.
operationId: AggregateRUMEvents
@@ -34452,10 +35746,13 @@
- AuthZ: []
summary: Aggregate RUM events
tags:
- RUM
x-codegen-request-body-name: body
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/rum/applications:
get:
description: List all the RUM applications in your organization.
operationId: GetRUMApplications
responses:
@@ -34470,10 +35767,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List all the RUM applications
tags:
- RUM
+ x-permission:
+ operator: OR
+ permissions:
+ - rum_apps_read
post:
description: Create a new RUM application in your organization.
operationId: CreateRUMApplication
requestBody:
content:
@@ -34494,10 +35795,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a new RUM application
tags:
- RUM
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - rum_apps_write
/api/v2/rum/applications/{id}:
delete:
description: Delete an existing RUM application in your organization.
operationId: DeleteRUMApplication
parameters:
@@ -34515,10 +35820,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a RUM application
tags:
- RUM
+ x-permission:
+ operator: OR
+ permissions:
+ - rum_apps_write
get:
description: Get the RUM application with given ID in your organization.
operationId: GetRUMApplication
parameters:
- description: RUM application ID.
@@ -34539,10 +35848,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a RUM application
tags:
- RUM
+ x-permission:
+ operator: OR
+ permissions:
+ - rum_apps_read
patch:
description: Update the RUM application with given ID in your organization.
operationId: UpdateRUMApplication
parameters:
- description: RUM application ID.
@@ -34578,10 +35891,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a RUM application
tags:
- RUM
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - rum_apps_write
/api/v2/rum/events:
get:
description: 'List endpoint returns events that match a RUM search query.
[Results are paginated][1].
@@ -34663,10 +35980,13 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/rum/events/search:
post:
description: 'List endpoint returns RUM events that match a RUM search query.
[Results are paginated][1].
@@ -34707,10 +36027,13 @@
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/saml_configurations/idp_metadata:
post:
description: 'Endpoint for uploading IdP metadata for SAML setup.
@@ -34741,10 +36064,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Upload IdP metadata
tags:
- Organizations
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - org_management
/api/v2/scorecard/outcomes:
get:
description: Fetches all rule outcomes.
operationId: ListScorecardOutcomes
parameters:
@@ -35085,10 +36412,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get the latest Cloud Workload Security policy
tags:
- CSM Threats
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_cws_agent_rules_read
/api/v2/security_monitoring/cloud_workload_security/agent_rules:
get:
description: Get the list of Agent rules.
operationId: ListCloudWorkloadSecurityAgentRules
responses:
@@ -35103,10 +36434,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get all Cloud Workload Security Agent rules
tags:
- CSM Threats
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_cws_agent_rules_read
post:
description: Create a new Agent rule with the given parameters.
operationId: CreateCloudWorkloadSecurityAgentRule
requestBody:
content:
@@ -35132,10 +36467,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a Cloud Workload Security Agent rule
tags:
- CSM Threats
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_cws_agent_rules_write
/api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}:
delete:
description: Delete a specific Agent rule.
operationId: DeleteCloudWorkloadSecurityAgentRule
parameters:
@@ -35150,10 +36489,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete a Cloud Workload Security Agent rule
tags:
- CSM Threats
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_cws_agent_rules_write
get:
description: Get the details of a specific Agent rule.
operationId: GetCloudWorkloadSecurityAgentRule
parameters:
- $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID'
@@ -35171,10 +36514,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get a Cloud Workload Security Agent rule
tags:
- CSM Threats
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_cws_agent_rules_read
patch:
description: 'Update a specific Agent rule.
Returns the Agent rule object when the request is successful.'
operationId: UpdateCloudWorkloadSecurityAgentRule
@@ -35206,10 +36553,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a Cloud Workload Security Agent rule
tags:
- CSM Threats
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_cws_agent_rules_write
/api/v2/security_monitoring/configuration/security_filters:
get:
description: Get the list of configured security filters with their definitions.
operationId: ListSecurityFilters
responses:
@@ -35229,10 +36580,14 @@
- AuthZ:
- security_monitoring_filters_read
summary: Get all security filters
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_filters_read
post:
description: 'Create a security filter.
See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
@@ -35268,10 +36623,14 @@
- security_monitoring_filters_write
summary: Create a security filter
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_filters_write
/api/v2/security_monitoring/configuration/security_filters/{security_filter_id}:
delete:
description: Delete a specific security filter.
operationId: DeleteSecurityFilter
parameters:
@@ -35291,10 +36650,14 @@
- AuthZ:
- security_monitoring_filters_write
summary: Delete a security filter
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_filters_write
get:
description: 'Get the details of a specific security filter.
See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
@@ -35322,10 +36685,14 @@
- AuthZ:
- security_monitoring_filters_read
summary: Get a security filter
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_filters_read
patch:
description: 'Update a specific security filter.
Returns the security filter object when the request is successful.'
operationId: UpdateSecurityFilter
@@ -35362,10 +36729,14 @@
- security_monitoring_filters_write
summary: Update a security filter
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_filters_write
/api/v2/security_monitoring/configuration/suppressions:
get:
description: Get the list of all suppression rules.
operationId: ListSecurityMonitoringSuppressions
responses:
@@ -35531,10 +36902,14 @@
- AuthZ:
- security_monitoring_rules_read
summary: List rules
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_read
post:
description: Create a detection rule.
operationId: CreateSecurityMonitoringRule
requestBody:
content:
@@ -35562,10 +36937,14 @@
- security_monitoring_rules_write
summary: Create a detection rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_write
/api/v2/security_monitoring/rules/convert:
post:
description: 'Convert a rule that doesn''t (yet) exist from JSON to Terraform
for datadog provider
@@ -35601,10 +36980,14 @@
- security_monitoring_rules_write
summary: Convert a rule from JSON to Terraform
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_write
/api/v2/security_monitoring/rules/test:
post:
description: Test a rule.
operationId: TestSecurityMonitoringRule
requestBody:
@@ -35637,10 +37020,14 @@
- security_monitoring_rules_write
summary: Test a rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_write
/api/v2/security_monitoring/rules/validation:
post:
description: Validate a detection rule.
operationId: ValidateSecurityMonitoringRule
requestBody:
@@ -35665,10 +37052,14 @@
- security_monitoring_rules_write
summary: Validate a detection rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_write
/api/v2/security_monitoring/rules/{rule_id}:
delete:
description: Delete an existing rule. Default rules cannot be deleted.
operationId: DeleteSecurityMonitoringRule
parameters:
@@ -35688,10 +37079,14 @@
- AuthZ:
- security_monitoring_rules_write
summary: Delete an existing rule
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_write
get:
description: Get a rule's details.
operationId: GetSecurityMonitoringRule
parameters:
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
@@ -35712,10 +37107,14 @@
- AuthZ:
- security_monitoring_rules_read
summary: Get a rule's details
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_read
put:
description: 'Update an existing rule. When updating `cases`, `queries` or `options`,
the whole field
must be included. For example, when modifying a query all queries must be
@@ -35758,10 +37157,14 @@
- security_monitoring_rules_write
summary: Update an existing rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_write
/api/v2/security_monitoring/rules/{rule_id}/convert:
get:
description: 'Convert an existing rule from JSON to Terraform for datadog provider
resource datadog_security_monitoring_rule.'
@@ -35789,10 +37192,14 @@
- AuthZ:
- security_monitoring_rules_read
summary: Convert an existing rule from JSON to Terraform
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_read
/api/v2/security_monitoring/rules/{rule_id}/test:
post:
description: Test an existing rule.
operationId: TestExistingSecurityMonitoringRule
parameters:
@@ -35827,10 +37234,14 @@
- security_monitoring_rules_write
summary: Test an existing rule
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_rules_write
/api/v2/security_monitoring/signals:
get:
description: 'The list endpoint returns security signals that match a search
query.
@@ -35910,10 +37321,14 @@
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
limitParam: page[limit]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_signals_read
/api/v2/security_monitoring/signals/search:
post:
description: 'Returns security signals that match a search query.
Both this endpoint and the GET endpoint can be used interchangeably for listing
@@ -35951,10 +37366,14 @@
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_signals_read
/api/v2/security_monitoring/signals/{signal_id}:
get:
description: Get a signal's details.
operationId: GetSecurityMonitoringSignal
parameters:
@@ -35976,10 +37395,14 @@
- AuthZ:
- security_monitoring_signals_read
summary: Get a signal's details
tags:
- Security Monitoring
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_signals_read
/api/v2/security_monitoring/signals/{signal_id}/assignee:
patch:
description: Modify the triage assignee of a security signal.
operationId: EditSecurityMonitoringSignalAssignee
parameters:
@@ -36020,10 +37443,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Modify the triage assignee of a security signal
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_signals_write
/api/v2/security_monitoring/signals/{signal_id}/incidents:
patch:
description: Change the related incidents for a security signal.
operationId: EditSecurityMonitoringSignalIncidents
parameters:
@@ -36064,10 +37491,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Change the related incidents of a security signal
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_signals_write
/api/v2/security_monitoring/signals/{signal_id}/state:
patch:
description: Change the triage state of a security signal.
operationId: EditSecurityMonitoringSignalState
parameters:
@@ -36108,10 +37539,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Change the triage state of a security signal
tags:
- Security Monitoring
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - security_monitoring_signals_write
/api/v2/sensitive-data-scanner/config:
get:
description: List all the Scanning groups in your organization.
operationId: ListScanningGroups
responses:
@@ -36136,10 +37571,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List Scanning Groups
tags:
- Sensitive Data Scanner
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_read
patch:
description: Reorder the list of groups.
operationId: ReorderScanningGroups
requestBody:
content:
@@ -36170,10 +37609,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Reorder Groups
tags:
- Sensitive Data Scanner
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_write
/api/v2/sensitive-data-scanner/config/groups:
post:
description: 'Create a scanning group.
The request MAY include a configuration relationship.
@@ -36214,10 +37657,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create Scanning Group
tags:
- Sensitive Data Scanner
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_write
/api/v2/sensitive-data-scanner/config/groups/{group_id}:
delete:
description: Delete a given group.
operationId: DeleteScanningGroup
parameters:
@@ -36253,10 +37700,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete Scanning Group
tags:
- Sensitive Data Scanner
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_write
patch:
description: 'Update a group, including the order of the rules.
Rules within the group are reordered by including a rules relationship. If
the rules
@@ -36299,10 +37750,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update Scanning Group
tags:
- Sensitive Data Scanner
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_write
/api/v2/sensitive-data-scanner/config/rules:
post:
description: 'Create a scanning rule in a sensitive data scanner group, ordered
last.
@@ -36344,10 +37799,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create Scanning Rule
tags:
- Sensitive Data Scanner
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_write
/api/v2/sensitive-data-scanner/config/rules/{rule_id}:
delete:
description: Delete a given rule.
operationId: DeleteScanningRule
parameters:
@@ -36383,10 +37842,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete Scanning Rule
tags:
- Sensitive Data Scanner
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_write
patch:
description: 'Update a scanning rule.
The request body MUST NOT include a standard_pattern relationship, as that
relationship
@@ -36428,10 +37891,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update Scanning Rule
tags:
- Sensitive Data Scanner
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_write
/api/v2/sensitive-data-scanner/config/standard-patterns:
get:
description: Returns all standard patterns.
operationId: ListStandardPatterns
responses:
@@ -36456,10 +37923,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List standard patterns
tags:
- Sensitive Data Scanner
+ x-permission:
+ operator: OR
+ permissions:
+ - data_scanner_read
/api/v2/series:
post:
description: "The metrics end-point allows you to post time-series data that
can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is
500 kilobytes (512000 bytes). Compressed payloads must have a decompressed
@@ -36562,10 +38033,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create a service account
tags:
- Service Accounts
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - service_account_write
/api/v2/service_accounts/{service_account_id}/application_keys:
get:
description: List all application keys available for this service account.
operationId: ListServiceAccountApplicationKeys
parameters:
@@ -36604,10 +38079,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: List application keys for this service account
tags:
- Service Accounts
+ x-permission:
+ operator: OR
+ permissions:
+ - service_account_write
post:
description: Create an application key for this service account.
operationId: CreateServiceAccountApplicationKey
parameters:
- $ref: '#/components/parameters/ServiceAccountID'
@@ -36640,10 +38119,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Create an application key for this service account
tags:
- Service Accounts
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - service_account_write
/api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id}:
delete:
description: Delete an application key owned by this service account.
operationId: DeleteServiceAccountApplicationKey
parameters:
@@ -36667,10 +38150,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Delete an application key for this service account
tags:
- Service Accounts
+ x-permission:
+ operator: OR
+ permissions:
+ - service_account_write
get:
description: Get an application key owned by this service account.
operationId: GetServiceAccountApplicationKey
parameters:
- $ref: '#/components/parameters/ServiceAccountID'
@@ -36697,10 +38184,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get one application key for this service account
tags:
- Service Accounts
+ x-permission:
+ operator: OR
+ permissions:
+ - service_account_write
patch:
description: Edit an application key owned by this service account.
operationId: UpdateServiceAccountApplicationKey
parameters:
- $ref: '#/components/parameters/ServiceAccountID'
@@ -36740,10 +38231,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Edit an application key for this service account
tags:
- Service Accounts
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - service_account_write
/api/v2/services:
get:
deprecated: true
description: Get all incident services uploaded for the requesting user's organization.
If the `include[users]` query parameter is provided, the included attribute
@@ -36777,10 +38272,14 @@
- AuthZ:
- incident_read
summary: Get a list of all incident services
tags:
- Incident Services
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is deprecated.'
post:
deprecated: true
description: Creates a new incident service.
operationId: CreateIncidentService
@@ -36815,10 +38314,14 @@
- incident_settings_write
summary: Create a new incident service
tags:
- Incident Services
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_settings_write
x-unstable: '**Note**: This endpoint is deprecated.'
/api/v2/services/definitions:
get:
description: Get a list of all service definitions from the Datadog Service
Catalog.
@@ -36848,10 +38351,14 @@
- Service Definition
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_service_catalog_read
post:
description: Create or update service definition in the Datadog Service Catalog.
operationId: CreateOrUpdateServiceDefinitions
requestBody:
content:
@@ -36882,10 +38389,14 @@
- apm_service_catalog_write
summary: Create or update service definition
tags:
- Service Definition
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_service_catalog_write
/api/v2/services/definitions/{service_name}:
delete:
description: Delete a single service definition in the Datadog Service Catalog.
operationId: DeleteServiceDefinition
parameters:
@@ -36907,10 +38418,14 @@
- AuthZ:
- apm_service_catalog_write
summary: Delete a single service definition
tags:
- Service Definition
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_service_catalog_write
get:
description: Get a single service definition from the Datadog Service Catalog.
operationId: GetServiceDefinition
parameters:
- $ref: '#/components/parameters/ServiceName'
@@ -36938,10 +38453,14 @@
- AuthZ:
- apm_service_catalog_read
summary: Get a single service definition
tags:
- Service Definition
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_service_catalog_read
/api/v2/services/{service_id}:
delete:
deprecated: true
description: Deletes an existing incident service.
operationId: DeleteIncidentService
@@ -36966,10 +38485,14 @@
- AuthZ:
- incident_settings_write
summary: Delete an existing incident service
tags:
- Incident Services
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_settings_write
x-unstable: '**Note**: This endpoint is deprecated.'
get:
deprecated: true
description: 'Get details of an incident service. If the `include[users]` query
parameter is provided,
@@ -37002,10 +38525,14 @@
- AuthZ:
- incident_read
summary: Get details of an incident service
tags:
- Incident Services
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is deprecated.'
patch:
deprecated: true
description: Updates an existing incident service. Only provide the attributes
which should be updated as this request is a partial update.
@@ -37043,10 +38570,14 @@
- incident_settings_write
summary: Update an existing incident service
tags:
- Incident Services
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_settings_write
x-unstable: '**Note**: This endpoint is deprecated.'
/api/v2/slo/report:
post:
description: 'Create a job to generate an SLO report. The report job is processed
asynchronously and eventually results in a CSV report being available for
@@ -37222,10 +38753,14 @@
- apm_read
summary: Aggregate spans
tags:
- Spans
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - apm_read
/api/v2/spans/events:
get:
description: 'List endpoint returns spans that match a span search query.
[Results are paginated][1].
@@ -37377,10 +38912,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get the on-demand concurrency cap
tags:
- Synthetics
+ x-permission:
+ operator: OR
+ permissions:
+ - billing_read
post:
description: Save new value for on-demand concurrency cap.
operationId: SetOnDemandConcurrencyCap
requestBody:
content:
@@ -37400,10 +38939,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Save new value for on-demand concurrency cap
tags:
- Synthetics
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - billing_edit
/api/v2/team:
get:
description: 'Get all teams.
Can be used to search for teams using the `filter[keyword]` and `filter[me]`
@@ -37470,10 +39013,14 @@
- Teams
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
post:
description: 'Create a new team.
User IDs passed through the `users` relationship field are added to the team.'
operationId: CreateTeam
@@ -37508,10 +39055,15 @@
- teams_manage
summary: Create a team
tags:
- Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: AND
+ permissions:
+ - teams_read
+ - teams_manage
/api/v2/team/{team_id}:
delete:
description: Remove a team using the team's `id`.
operationId: DeleteTeam
parameters:
@@ -37541,10 +39093,15 @@
- teams_read
- teams_manage
summary: Remove a team
tags:
- Teams
+ x-permission:
+ operator: AND
+ permissions:
+ - teams_read
+ - teams_manage
get:
description: Get a single team using the team's `id`.
operationId: GetTeam
parameters:
- description: None
@@ -37576,10 +39133,14 @@
- AuthZ:
- teams_read
summary: Get a team
tags:
- Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
patch:
description: 'Update a team using the team''s `id`.
If the `team_links` relationship is present, the associated links are updated
to be in the order they appear in the array, and any existing team links not
@@ -37634,10 +39195,14 @@
- teams_read
summary: Update a team
tags:
- Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/team/{team_id}/links:
get:
description: Get all links for a given team.
operationId: GetTeamLinks
parameters:
@@ -37670,10 +39235,14 @@
- AuthZ:
- teams_read
summary: Get links for a team
tags:
- Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
post:
description: Add a new link to a team.
operationId: CreateTeamLink
parameters:
- description: None
@@ -37718,10 +39287,14 @@
- teams_read
summary: Create a team link
tags:
- Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/team/{team_id}/links/{link_id}:
delete:
description: Remove a link from a team.
operationId: DeleteTeamLink
parameters:
@@ -37756,10 +39329,14 @@
- AuthZ:
- teams_read
summary: Remove a team link
tags:
- Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
get:
description: Get a single link for a team.
operationId: GetTeamLink
parameters:
- description: None
@@ -37797,10 +39374,14 @@
- AuthZ:
- teams_read
summary: Get a team link
tags:
- Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
patch:
description: Update a team link.
operationId: UpdateTeamLink
parameters:
- description: None
@@ -37845,10 +39426,14 @@
- teams_read
summary: Update a team link
tags:
- Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/team/{team_id}/memberships:
get:
description: Get a paginated list of members for a team
operationId: GetTeamMemberships
parameters:
@@ -37899,10 +39484,14 @@
- Teams
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
post:
description: Add a user to a team.
operationId: CreateTeamMembership
parameters:
- description: None
@@ -37947,10 +39536,14 @@
- teams_read
summary: Add a user to a team
tags:
- Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/team/{team_id}/memberships/{user_id}:
delete:
description: Remove a user from a team.
operationId: DeleteTeamMembership
parameters:
@@ -37985,10 +39578,14 @@
- AuthZ:
- teams_read
summary: Remove a user from a team
tags:
- Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
patch:
description: Update a user's membership attributes on a team.
operationId: UpdateTeamMembership
parameters:
- description: None
@@ -38033,10 +39630,14 @@
- teams_read
summary: Update a user's membership attributes on a team
tags:
- Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/team/{team_id}/permission-settings:
get:
description: Get all permission settings for a given team.
operationId: GetTeamPermissionSettings
parameters:
@@ -38069,10 +39670,14 @@
- AuthZ:
- teams_read
summary: Get permission settings for a team
tags:
- Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/team/{team_id}/permission-settings/{action}:
put:
description: Update a team permission setting for a given team.
operationId: UpdateTeamPermissionSetting
parameters:
@@ -38118,10 +39723,14 @@
- teams_read
summary: Update permission setting for team
tags:
- Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/teams:
get:
deprecated: true
description: Get all incident teams for the requesting user's organization.
If the `include[users]` query parameter is provided, the included attribute
@@ -38155,10 +39764,14 @@
- AuthZ:
- incident_read
summary: Get a list of all incident teams
tags:
- Incident Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
post:
deprecated: true
description: Creates a new incident team.
operationId: CreateIncidentTeam
@@ -38193,10 +39806,14 @@
- incident_settings_write
summary: Create a new incident team
tags:
- Incident Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_settings_write
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
/api/v2/teams/{team_id}:
delete:
deprecated: true
description: Deletes an existing incident team.
@@ -38222,10 +39839,14 @@
- AuthZ:
- incident_settings_write
summary: Delete an existing incident team
tags:
- Incident Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_settings_write
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
get:
deprecated: true
description: 'Get details of an incident team. If the `include[users]` query
parameter is provided,
@@ -38258,10 +39879,14 @@
- AuthZ:
- incident_read
summary: Get details of an incident team
tags:
- Incident Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_read
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
patch:
deprecated: true
description: Updates an existing incident team. Only provide the attributes
which should be updated as this request is a partial update.
@@ -38299,10 +39924,14 @@
- incident_settings_write
summary: Update an existing incident team
tags:
- Incident Teams
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - incident_settings_write
x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
/api/v2/usage/application_security:
get:
deprecated: true
description: 'Get hourly usage for application security .
@@ -38360,10 +39989,14 @@
- AuthZ:
- usage_read
summary: Get hourly usage for application security
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/usage/cost_by_org:
get:
deprecated: true
description: 'Get cost across multi-org account.
@@ -38427,10 +40060,14 @@
- AuthZ:
- usage_read
summary: Get cost across multi-org account
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/usage/estimated_cost:
get:
description: 'Get estimated cost across multi-org and single root-org accounts.
Estimated cost data is only available for the current month and previous month
@@ -38527,10 +40164,14 @@
- AuthZ:
- usage_read
summary: Get estimated cost across your account
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/usage/historical_cost:
get:
description: 'Get historical cost across multi-org and single root-org accounts.
Cost data for a given month becomes available no later than the 16th of the
@@ -38604,10 +40245,14 @@
- AuthZ:
- usage_read
summary: Get historical cost across your account
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/usage/hourly_usage:
get:
description: Get hourly usage by product family.
operationId: GetHourlyUsage
parameters:
@@ -38629,26 +40274,29 @@
type: string
- description: 'Comma separated list of product families to retrieve. Available
families are `all`, `analyzed_logs`,
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
+ `cloud_siem`,
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
`cws`, `dbm`, `error_tracking`,
`fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`,
`ingested_spans`, `iot`,
- `lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `netflow_monitoring`,
+ `lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`,
`observability_pipelines`,
`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`,
`sds`, `snmp`,
`synthetics_api`, `synthetics_browser`, `synthetics_mobile`, `synthetics_parallel_testing`,
- and `timeseries`.
+ `timeseries`, `vuln_management`,
+ and `workflow_executions`.
+
The following product family has been **deprecated**: `audit_logs`.'
in: query
name: filter[product_families]
required: true
schema:
@@ -38738,10 +40386,14 @@
- AuthZ:
- usage_read
summary: Get hourly usage by product family
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/usage/lambda_traced_invocations:
get:
deprecated: true
description: 'Get hourly usage for Lambda traced invocations.
@@ -38798,10 +40450,14 @@
- AuthZ:
- usage_read
summary: Get hourly usage for Lambda traced invocations
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/usage/observability_pipelines:
get:
deprecated: true
description: 'Get hourly usage for observability pipelines.
@@ -38858,10 +40514,14 @@
- AuthZ:
- usage_read
summary: Get hourly usage for observability pipelines
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/usage/projected_cost:
get:
description: 'Get projected cost across multi-org and single root-org accounts.
Projected cost data is only available for the current month and becomes available
@@ -38919,10 +40579,14 @@
- AuthZ:
- usage_read
summary: Get projected cost across your account
tags:
- Usage Metering
+ x-permission:
+ operator: OR
+ permissions:
+ - usage_read
/api/v2/user_invitations:
post:
description: Sends emails to one or more users inviting them to join the organization.
operationId: SendInvitations
requestBody:
@@ -38959,10 +40623,14 @@
- user_access_invite
summary: Send invitation emails
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_invite
/api/v2/user_invitations/{user_invitation_uuid}:
get:
description: Returns a single user invitation by its UUID.
operationId: GetInvitation
parameters:
@@ -39001,10 +40669,14 @@
- user_access_invite
summary: Get a user invitation
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_invite
/api/v2/users:
get:
description: 'Get the list of all users in the organization. This list includes
all users even if they are deactivated or unverified.'
@@ -39082,10 +40754,14 @@
x-codegen-request-body-name: body
x-pagination:
limitParam: page[size]
pageParam: page[number]
resultsPath: data
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_read
post:
description: Create a user for your organization.
operationId: CreateUser
requestBody:
content:
@@ -39121,10 +40797,14 @@
- user_access_invite
summary: Create a user
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_invite
/api/v2/users/{user_id}:
delete:
description: 'Disable a user. Can only be used with an application key belonging
to an administrator user.'
@@ -39155,10 +40835,15 @@
- user_access_manage
summary: Disable a user
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
+ - service_account_write
get:
description: "Get a user in the organization specified by the user\u2019s `user_id`."
operationId: GetUser
parameters:
- $ref: '#/components/parameters/UserID'
@@ -39190,10 +40875,14 @@
- user_access_read
summary: Get user details
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_read
patch:
description: 'Edit a user. Can only be used with an application key belonging
to an administrator user.'
operationId: UpdateUser
@@ -39245,10 +40934,15 @@
- user_access_manage
summary: Update a user
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_manage
+ - service_account_write
/api/v2/users/{user_id}/orgs:
get:
description: 'Get a user organization. Returns the user information and all
organizations
@@ -39283,10 +40977,13 @@
- AuthZ: []
summary: Get a user organization
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OPEN
+ permissions: []
/api/v2/users/{user_id}/permissions:
get:
description: "Get a user permission set. Returns a list of the user\u2019s permissions\ngranted
by the associated user's roles."
operationId: ListUserPermissions
@@ -39320,10 +41017,14 @@
- user_access_read
summary: Get a user permissions
tags:
- Users
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - user_access_read
/api/v2/users/{user_uuid}/memberships:
get:
description: Get a list of memberships for a user
operationId: GetUserMemberships
parameters:
@@ -39354,10 +41055,14 @@
- AuthZ:
- teams_read
summary: Get user memberships
tags:
- Teams
+ x-permission:
+ operator: OR
+ permissions:
+ - teams_read
/api/v2/workflows/{workflow_id}/instances:
get:
description: List all instances of a given workflow. This API requires an application
key scoped with the workflows_read permission.
operationId: ListWorkflowInstances
@@ -39384,10 +41089,14 @@
- AuthZ:
- workflows_read
summary: List workflow instances
tags:
- Workflow Automation
+ x-permission:
+ operator: OR
+ permissions:
+ - workflows_read
post:
description: Execute the given workflow. This API requires an application key
scoped with the workflows_run permission.
operationId: CreateWorkflowInstance
parameters:
@@ -39413,10 +41122,14 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Execute a workflow
tags:
- Workflow Automation
x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - workflows_run
/api/v2/workflows/{workflow_id}/instances/{instance_id}:
get:
description: Get a specific execution of a given workflow. This API requires
an application key scoped with the workflows_read permission.
operationId: GetWorkflowInstance
@@ -39444,10 +41157,14 @@
- AuthZ:
- workflows_read
summary: Get a workflow instance
tags:
- Workflow Automation
+ x-permission:
+ operator: OR
+ permissions:
+ - workflows_read
/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
put:
description: Cancels a specific execution of a given workflow. This API requires
an application key scoped with the workflows_run permission.
operationId: CancelWorkflowInstance
@@ -39470,10 +41187,14 @@
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Cancel a workflow instance
tags:
- Workflow Automation
+ x-permission:
+ operator: OR
+ permissions:
+ - workflows_run
security:
- apiKeyAuth: []
appKeyAuth: []
servers:
- url: https://{subdomain}.{site}
@@ -39679,9 +41400,18 @@
between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete
`manage_tags` API methods can only be performed by\na user who has the `Manage
Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/)
for more information."
name: Metrics
+- description: 'Configure your [Datadog Microsoft Teams integration](https://docs.datadoghq.com/integrations/microsoft_teams/)
+
+ directly through the Datadog API. Note: These endpoints do not support legacy
+ connector handles.'
+ externalDocs:
+ description: For more information about the Datadog Microsoft Teams integration,
+ see the integration page.
+ url: https://docs.datadoghq.com/integrations/microsoft_teams/
+ name: Microsoft Teams Integration
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
a metric or check that you care about and
notifies your team when a defined threshold has exceeded.