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 State 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: State
paths:
/api/v2/security_monitoring/signals/{signal_id}/state:
patch:
description: Change the triage state of a security signal.
operationId: EditSecurityMonitoringSignalState
parameters:
- $ref: '#/components/parameters/SignalID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateRequest'
description: Attributes describing the signal update.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Change the Triage State of a Security Signal
tags:
- State
x-codegen-request-body-name: body
x-menu-order: 12
x-permission:
operator: OR
permissions:
- security_monitoring_signals_write
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
parameters:
SignalID:
description: The ID of the signal.
in: path
name: signal_id
required: true
schema:
type: string
schemas:
SecurityMonitoringTriageUser:
description: Object representing a given user entity.
properties:
handle:
description: The handle for this user account.
type: string
example: example_value
icon:
description: Gravatar icon associated to the user.
example: /path/to/matching/gravatar/icon
readOnly: true
type: string
id:
description: Numerical ID assigned by Datadog to this user account.
format: int64
type: integer
example: 42
name:
description: The name for this user account.
nullable: true
type: string
example: Example Monitor
uuid:
description: UUID assigned by Datadog to this user account.
example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
type: string
required:
- uuid
type: object
SecurityMonitoringSignalStateUpdateAttributes:
description: Attributes describing the change of state of a security signal.
properties:
archive_comment:
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
archive_reason:
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
state:
$ref: '#/components/schemas/SecurityMonitoringSignalState'
version:
$ref: '#/components/schemas/SecurityMonitoringSignalVersion'
required:
- 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
SecurityMonitoringSignalTriageAttributes:
description: Attributes describing a triage state update operation over a security signal.
properties:
archive_comment:
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
archive_comment_timestamp:
description: Timestamp of the last edit to the comment.
format: int64
minimum: 0
type: integer
example: 42
archive_comment_user:
$ref: '#/components/schemas/SecurityMonitoringTriageUser'
archive_reason:
$ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
assignee:
$ref: '#/components/schemas/SecurityMonitoringTriageUser'
incident_ids:
$ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds'
state:
$ref: '#/components/schemas/SecurityMonitoringSignalState'
state_update_timestamp:
description: Timestamp of the last update to the signal state.
format: int64
minimum: 0
type: integer
example: 42
state_update_user:
$ref: '#/components/schemas/SecurityMonitoringTriageUser'
required:
- assignee
- state
- incident_ids
type: object
SecurityMonitoringSignalTriageUpdateResponse:
description: The response returned after all triage operations, containing the updated signal triage data.
properties:
data:
$ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateData'
required:
- data
type: object
SecurityMonitoringSignalState:
description: The new triage state of the signal.
enum:
- open
- archived
- under_review
example: open
type: string
x-enum-varnames:
- OPEN
- ARCHIVED
- UNDER_REVIEW
SecurityMonitoringSignalIncidentIds:
description: Array of incidents that are associated with this signal.
example:
- 2066
items:
description: Public ID attribute of the incident that is associated with the signal.
example: 2066
format: int64
type: integer
type: array
SecurityMonitoringSignalArchiveReason:
description: Reason a signal is archived.
enum:
- none
- false_positive
- testing_or_maintenance
- investigated_case_opened
- other
type: string
x-enum-varnames:
- NONE
- FALSE_POSITIVE
- TESTING_OR_MAINTENANCE
- INVESTIGATED_CASE_OPENED
- OTHER
SecurityMonitoringSignalVersion:
description: Version of the updated signal. If server side version is higher, update will be rejected.
format: int64
type: integer
SecurityMonitoringSignalArchiveComment:
description: Optional comment to display on archived signals.
type: string
SecurityMonitoringSignalStateUpdateRequest:
description: Request body for changing the state of a given security monitoring signal.
properties:
data:
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateData'
required:
- data
type: object
SecurityMonitoringSignalTriageUpdateData:
description: Data containing the updated triage attributes of the signal.
properties:
attributes:
$ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes'
id:
description: The unique ID of the security signal.
type: string
example: abc-123-def
type:
$ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
type: object
SecurityMonitoringSignalMetadataType:
default: signal_metadata
description: The type of event.
enum:
- signal_metadata
example: signal_metadata
type: string
x-enum-varnames:
- SIGNAL_METADATA
SecurityMonitoringSignalStateUpdateData:
description: Data containing the patch for changing the state of a signal.
properties:
attributes:
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes'
id:
description: The unique ID of the security signal.
example: abc-123-def
type:
$ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
required:
- attributes
type: object
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
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