How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datadog Signal API

The Signal API from Datadog — 4 operation(s) for signal.

Datadog Signal API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Signal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.

4 operations 4 paths 25 schemas 3 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.datadoghq.com
Authentication
OAuth 2.0, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Datadog Signal API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes. An API key is passed in the header as DD-API-KEY (apiKeyAuth). An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • AuthZ — This API uses OAuth 2 with the implicit grant flow.
  • apiKeyAuth — Your Datadog API Key.
  • appKeyAuth — Your Datadog APP Key.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Signal 4
PATCH
/api/v2/security_monitoring/signals/{signal_id}/assignee
Datadog Modify the Triage Assignee of a Security Signal
EditSecurityMonitoringSignalAssignee 1 param body → 200400403404429
PATCH
/api/v2/security_monitoring/signals/{signal_id}/incidents
Datadog Change the Related Incidents of a Security Signal
EditSecurityMonitoringSignalIncidents 1 param body → 200400403404429
PATCH
/api/v2/security_monitoring/signals/{signal_id}/state
Datadog Change the Triage State of a Security Signal
EditSecurityMonitoringSignalState 1 param body → 200400403404429
POST
/api/v2/siem-historical-detections/jobs/signal_convert
Datadog Convert a Job Result to a Signal
ConvertJobResultToSignal body → 204400401403404429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are SecurityMonitoringSignalTriageAttributes (9 properties), SecurityMonitoringTriageUser (5 properties), ConvertJobResultsToSignalsAttributes (5 properties), SecurityMonitoringSignalStateUpdateAttributes (4 properties). Each schema is shown below with its type and property counts.

SecurityMonitoringSignalIncidentsUpdateData
object
Data containing the patch for changing the related incidents of a signal.
1 property 1 required
SecurityMonitoringSignalIncidentsUpdateRequest
object
Request body for changing the related incidents of a given security monitoring signal.
1 property 1 required
SecurityMonitoringSignalAssigneeUpdateAttributes
object
Attributes describing the new assignee of a security signal.
2 properties 1 required
SecurityMonitoringSignalIncidentIds
array
Array of incidents that are associated with this signal.
SecurityMonitoringSignalArchiveComment
string
Optional comment to display on archived signals.
ConvertJobResultsToSignalsAttributes
object
Attributes for converting historical job results to signals.
5 properties 4 required
APIErrorResponse
object
API error response.
1 property 1 required
SecurityMonitoringSignalStateUpdateAttributes
object
Attributes describing the change of state of a security signal.
4 properties 1 required
SecurityMonitoringSignalTriageAttributes
object
Attributes describing a triage state update operation over a security signal.
9 properties 3 required
SecurityMonitoringSignalTriageUpdateResponse
object
The response returned after all triage operations, containing the updated signal triage data.
1 property 1 required
ConvertJobResultsToSignalsDataType
string
Type of payload.
ConvertJobResultsToSignalsData
object
Data for converting historical job results to signals.
2 properties
SecurityMonitoringSignalVersion
integer
Version of the updated signal. If server side version is higher, update will be rejected.
ConvertJobResultsToSignalsRequest
object
Request for converting historical job results to signals.
1 property
SecurityMonitoringSignalAssigneeUpdateRequest
object
Request body for changing the assignee of a given security monitoring signal.
1 property 1 required
SecurityMonitoringSignalIncidentsUpdateAttributes
object
Attributes describing the new list of related signals for a security signal.
2 properties 1 required
SecurityMonitoringSignalArchiveReason
string
Reason a signal is archived.
SecurityMonitoringSignalStateUpdateRequest
object
Request body for changing the state of a given security monitoring signal.
1 property 1 required
SecurityMonitoringSignalAssigneeUpdateData
object
Data containing the patch for changing the assignee of a signal.
1 property 1 required
SecurityMonitoringSignalTriageUpdateData
object
Data containing the updated triage attributes of the signal.
3 properties
SecurityMonitoringSignalStateUpdateData
object
Data containing the patch for changing the state of a signal.
3 properties 1 required
SecurityMonitoringTriageUser
object
Object representing a given user entity.
5 properties 1 required
SecurityMonitoringSignalState
string
The new triage state of the signal.
SecurityMonitoringRuleSeverity
string
Severity of the Security Signal.
SecurityMonitoringSignalMetadataType
string
The type of event.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-signal-api-openapi.yml Raw ↑

Other APIs Datadog publishes across the network.

Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
Where this information came from

This is an independent, third-party profile of Datadog Signal API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.