openapi: 3.0.0
info:
contact:
email: support@datadoghq.com
name: Datadog Support
url: https://www.datadoghq.com/support/
description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
title: Datadog Account Batch API
version: '1.0'
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for Datadog customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: api
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
appKeyAuth: []
tags:
- name: Batch
paths:
/api/v2/posture_management/findings:
patch:
description: Mute or unmute findings.
operationId: MuteFindings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkMuteFindingsRequest'
description: "### Attributes\n\nAll findings are updated with the same attributes. The request body must include at least two attributes: `muted` and `reason`.\nThe allowed reasons depend on whether the finding is being muted or unmuted:\n - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`.\n - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`, `OTHER`.\n\n### Meta\n\nThe request body must include a list of the finding IDs to be updated.\n"
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BulkMuteFindingsResponse'
description: OK
'400':
$ref: '#/components/responses/FindingsBadRequestResponse'
'403':
$ref: '#/components/responses/FindingsForbiddenResponse'
'404':
$ref: '#/components/responses/FindingsNotFoundResponse'
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
description: 'Invalid Request: The server understands the request syntax but cannot process it due to invalid data.'
'429':
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
summary: Datadog Mute or Unmute a Batch of Findings
tags:
- Batch
x-codegen-request-body-name: body
x-menu-order: 2
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/scorecard/outcomes/batch:
post:
description: Sets multiple service-rule outcomes in a single batched request.
operationId: CreateScorecardOutcomesBatch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OutcomesBatchRequest'
description: Set of scorecard outcomes.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OutcomesBatchResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- apm_service_catalog_write
summary: Datadog Create Outcomes Batch
tags:
- Batch
x-codegen-request-body-name: body
x-menu-order: 1
x-undo:
type: idempotent
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
OutcomeType:
default: outcome
description: The JSON:API type for an outcome.
enum:
- outcome
example: outcome
type: string
x-enum-varnames:
- OUTCOME
OutcomesBatchAttributes:
description: The JSON:API attributes for a batched set of scorecard outcomes.
properties:
results:
description: Set of scorecard outcomes to update.
items:
$ref: '#/components/schemas/OutcomesBatchRequestItem'
type: array
type: object
OutcomesResponseDataItem:
description: A single rule outcome.
properties:
attributes:
$ref: '#/components/schemas/OutcomesBatchResponseAttributes'
id:
description: The unique ID for a rule outcome.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/RuleOutcomeRelationships'
type:
$ref: '#/components/schemas/OutcomeType'
type: object
BulkMuteFindingsResponse:
description: The expected response schema.
properties:
data:
$ref: '#/components/schemas/BulkMuteFindingsResponseData'
required:
- data
type: object
JSONAPIErrorItem:
description: API error response body
properties:
detail:
description: A human-readable explanation specific to this occurrence of the error.
example: Missing required attribute in body
type: string
meta:
additionalProperties: {}
description: Non-standard meta-information about the error
type: object
source:
$ref: '#/components/schemas/JSONAPIErrorItemSource'
status:
description: Status code of the response.
example: '400'
type: string
title:
description: Short human-readable summary of the error.
example: Bad Request
type: string
type: object
OutcomesBatchType:
default: batched-outcome
description: The JSON:API type for scorecard outcomes.
enum:
- batched-outcome
example: batched-outcome
type: string
x-enum-varnames:
- BATCHED_OUTCOME
RuleId:
description: The unique ID for a scorecard rule.
example: q8MQxk8TCqrHnWkx
type: string
OutcomesBatchResponseData:
description: List of rule outcomes which were affected during the bulk operation.
items:
$ref: '#/components/schemas/OutcomesResponseDataItem'
type: array
OutcomesBatchResponseAttributes:
description: The JSON:API attributes for an outcome.
properties:
created_at:
description: Creation time of the rule outcome.
format: date-time
type: string
example: example_value
modified_at:
description: Time of last rule outcome modification.
format: date-time
type: string
example: example_value
remarks:
description: Any remarks regarding the scorecard rule's evaluation, and supports HTML hyperlinks.
example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
type: string
service_name:
description: The unique name for a service in the catalog.
example: my-service
type: string
state:
$ref: '#/components/schemas/State'
type: object
APIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
example:
- Bad Request
items:
description: A list of items.
example: Bad Request
type: string
type: array
required:
- errors
type: object
RuleType:
default: rule
description: The JSON:API type for scorecard rules.
enum:
- rule
example: rule
type: string
x-enum-varnames:
- RULE
OutcomesBatchRequestData:
description: Scorecard outcomes batch request data.
properties:
attributes:
$ref: '#/components/schemas/OutcomesBatchAttributes'
type:
$ref: '#/components/schemas/OutcomesBatchType'
type: object
BulkMuteFindingsRequestMeta:
description: Meta object containing the findings to be updated.
properties:
findings:
description: Array of findings.
items:
$ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings'
type: array
type: object
BulkMuteFindingsRequest:
description: The new bulk mute finding request.
properties:
data:
$ref: '#/components/schemas/BulkMuteFindingsRequestData'
required:
- data
type: object
RuleOutcomeRelationships:
description: The JSON:API relationship to a scorecard rule.
properties:
rule:
$ref: '#/components/schemas/RelationshipToOutcome'
type: object
RelationshipToOutcome:
description: The JSON:API relationship to a scorecard outcome.
properties:
data:
$ref: '#/components/schemas/RelationshipToOutcomeData'
type: object
JSONAPIErrorItemSource:
description: References to the source of the error.
properties:
header:
description: A string indicating the name of a single request header which caused the error.
example: Authorization
type: string
parameter:
description: A string indicating which URI query parameter caused the error.
example: limit
type: string
pointer:
description: A JSON pointer to the value in the request document that caused the error.
example: /data/attributes/title
type: string
type: object
JSONAPIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
items:
$ref: '#/components/schemas/JSONAPIErrorItem'
type: array
required:
- errors
type: object
BulkMuteFindingsRequestData:
description: Data object containing the new bulk mute properties of the finding.
properties:
attributes:
$ref: '#/components/schemas/BulkMuteFindingsRequestAttributes'
id:
description: UUID to identify the request
example: dbe5f567-192b-4404-b908-29b70e1c9f76
type: string
meta:
$ref: '#/components/schemas/BulkMuteFindingsRequestMeta'
type:
$ref: '#/components/schemas/FindingType'
required:
- id
- type
- attributes
- meta
type: object
FindingType:
default: finding
description: The JSON:API type for findings.
enum:
- finding
example: finding
type: string
x-enum-varnames:
- FINDING
FindingID:
description: The unique ID for this finding.
example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
type: string
RelationshipToOutcomeData:
description: The JSON:API relationship to an outcome, which returns the related rule id.
properties:
id:
$ref: '#/components/schemas/RuleId'
type:
$ref: '#/components/schemas/RuleType'
type: object
OutcomesBatchRequest:
description: Scorecard outcomes batch request.
properties:
data:
$ref: '#/components/schemas/OutcomesBatchRequestData'
type: object
OutcomesBatchRequestItem:
description: Scorecard outcome for a specific rule, for a given service within a batched update.
properties:
remarks:
description: Any remarks regarding the scorecard rule's evaluation, and supports HTML hyperlinks.
example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
type: string
rule_id:
$ref: '#/components/schemas/RuleId'
service_name:
description: The unique name for a service in the catalog.
example: my-service
type: string
state:
$ref: '#/components/schemas/State'
required:
- rule_id
- service_name
- state
type: object
State:
description: The state of the rule evaluation.
enum:
- pass
- fail
- skip
example: pass
type: string
x-enum-varnames:
- PASS
- FAIL
- SKIP
BulkMuteFindingsRequestAttributes:
additionalProperties: false
description: The mute properties to be updated.
properties:
mute:
$ref: '#/components/schemas/BulkMuteFindingsRequestProperties'
required:
- mute
type: object
OutcomesBatchResponseMeta:
description: Metadata pertaining to the bulk operation.
properties:
total_received:
description: Total number of scorecard results received during the bulk operation.
format: int64
type: integer
example: 42
total_updated:
description: Total number of scorecard results modified during the bulk operation.
format: int64
type: integer
example: 42
type: object
FindingMuteReason:
description: The reason why this finding is muted or unmuted.
enum:
- PENDING_FIX
- FALSE_POSITIVE
- ACCEPTED_RISK
- NO_PENDING_FIX
- HUMAN_ERROR
- NO_LONGER_ACCEPTED_RISK
- OTHER
example: ACCEPTED_RISK
type: string
x-enum-varnames:
- PENDING_FIX
- FALSE_POSITIVE
- ACCEPTED_RISK
- NO_PENDING_FIX
- HUMAN_ERROR
- NO_LONGER_ACCEPTED_RISK
- OTHER
BulkMuteFindingsResponseData:
description: Data object containing the ID of the request that was updated.
properties:
id:
description: UUID used to identify the request
example: 93bfeb70-af47-424d-908a-948d3f08e37f
type: string
type:
$ref: '#/components/schemas/FindingType'
type: object
BulkMuteFindingsRequestProperties:
additionalProperties: false
description: Object containing the new mute properties of the findings.
properties:
description:
description: Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.
type: string
example: example_value
expiration_date:
description: 'The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.
If this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.
'
example: 1778721573794
format: int64
type: integer
muted:
description: Whether those findings should be muted or unmuted.
example: true
type: boolean
reason:
$ref: '#/components/schemas/FindingMuteReason'
required:
- muted
- reason
type: object
OutcomesBatchResponse:
description: Scorecard outcomes batch response.
properties:
data:
$ref: '#/components/schemas/OutcomesBatchResponseData'
meta:
$ref: '#/components/schemas/OutcomesBatchResponseMeta'
required:
- data
- meta
type: object
BulkMuteFindingsRequestMetaFindings:
description: Finding object containing the finding information.
properties:
finding_id:
$ref: '#/components/schemas/FindingID'
type: object
responses:
FindingsTooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
description: 'Too many requests: The rate limit set by the API has been exceeded.'
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
FindingsNotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
description: 'Not Found: The requested finding cannot be found.'
FindingsBadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
description: 'Bad Request: The server cannot process the request due to invalid syntax in the request.'
FindingsForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
description: 'Forbidden: Access denied'
ForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_api_catalog_read: View API catalog and API definitions.
apm_api_catalog_write: Add, modify, and delete API catalog definitions.
apm_read: Read and query APM and Trace Analytics.
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
cases_read: View Cases.
cases_write: Create and update cases.
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
ci_visibility_read: View CI Visibility.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
code_analysis_read: View Code Analysis.
continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
create_webhooks: Create webhooks integrations.
dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
data_scanner_read: View Data Scanner configurations.
data_scanner_write: Edit Data Scanner configurations.
embeddable_graphs_share: Generate public links to share embeddable graphs externally.
events_read: Read Events data.
hosts_read: List hosts and their attributes.
incident_notification_settings_write: Configure Incidents Notification settings.
incident_read: View incidents in Datadog.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
monitor_config_policy_write: Edit and delete monitor configuration.
monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
monitors_read: View monitors.
monitors_write: Edit, delete, and resolve individual monitors.
org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
security_comments_read: Read comments of vulnerabilities.
security_monitoring_filters_read: Read Security Filters.
security_monitoring_filters_write: Create, edit, and delete Security Filters.
security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
security_monitoring_notification_profiles_read: View Rule Security Notification rules.
security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
security_monitoring_rules_read: Read Detection Rules.
security_monitoring_rules_write: Create and edit Detection Rules.
security_monitoring_signals_read: View Security Signals.
security_monitoring_suppressions_read: Read Rule Suppressions.
security_monitoring_suppressions_write: Write Rule Suppressions.
security_pipelines_read: View Security Pipelines.
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
slos_read: View SLOs and status corrections.
slos_write: Create, edit, and delete SLOs.
synthetics_global_variable_read: View, search, and use Synthetics global variables.
synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
synthetics_private_location_read: View, search, and use Synthetics private locations.
synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
synthetics_read: List and view configured Synthetic tests and test results.
synthetics_write: Create, edit, and delete Synthetic tests.
teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
test_optimization_read: View Test Optimization.
timeseries_query: Query Timeseries data.
usage_read: View your organization's usage and usage attribution.
user_access_invite: Invite other users to your organization.
user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
user_access_read: View users and their roles and settings.
workflows_read: View workflows.
workflows_run: Run workflows.
workflows_write: Create, edit, and delete workflows.
tokenUrl: /oauth2/v1/token
type: oauth2
apiKeyAuth:
description: Your Datadog API Key.
in: header
name: DD-API-KEY
type: apiKey
x-env-name: DD_API_KEY
appKeyAuth:
description: Your Datadog APP Key.
in: header
name: DD-APPLICATION-KEY
type: apiKey
x-env-name: DD_APP_KEY
bearerAuth:
scheme: bearer
type: http
x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
paths: false