- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Manage incident response, as well as associated attachments, metadata, and todos. See the Incident Management page for more information.
Note: This endpoint is in public beta. If you have any feedback, contact Datadog support.
POST https://api.ap1.datadoghq.com/api/v2/incidentshttps://api.datadoghq.eu/api/v2/incidentshttps://api.ddog-gov.com/api/v2/incidentshttps://api.datadoghq.com/api/v2/incidentshttps://api.us3.datadoghq.com/api/v2/incidentshttps://api.us5.datadoghq.com/api/v2/incidents
Create an incident.
This endpoint requires the incident_write
permission.
OAuth apps require the incident_write
authorization scope to access this endpoint.
Incident payload.
항목
유형
설명
data [required]
object
Incident data for a create request.
attributes [required]
object
The incident's attributes for a create request.
customer_impact_scope
string
Required if customer_impacted:"true"
. A summary of the impact customers experienced during the incident.
customer_impacted [required]
boolean
A flag indicating whether the incident caused customer impact.
fields
object
A condensed view of the user-defined fields for which to create initial selections.
<any-key>
<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
object
A field with a single value selected.
type
enum
Type of the single value field definitions.
Allowed enum values: dropdown,textbox
default: dropdown
value
string
The single value selected for this field.
Option 2
object
A field with potentially multiple values selected.
type
enum
Type of the multiple value field definitions.
Allowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
[string]
The multiple values selected for this field.
initial_cells
[ <oneOf>]
An array of initial timeline cells to be placed at the beginning of the incident timeline.
Option 1
object
Timeline cell data for Markdown timeline cells for a create request.
cell_type [required]
enum
Type of the Markdown timeline cell.
Allowed enum values: markdown
default: markdown
content [required]
object
The Markdown timeline cell contents.
content
string
The Markdown content of the cell.
important
boolean
A flag indicating whether the timeline cell is important and should be highlighted.
notification_handles
[object]
Notification handles that will be notified of the incident at creation.
display_name
string
The name of the notified handle.
handle
string
The handle used for the notification. This includes an email address, Slack channel, or workflow.
title [required]
string
The title of the incident, which summarizes what happened.
relationships
object
The relationships the incident will have with other resources once created.
commander_user [required]
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
type [required]
enum
Incident resource type.
Allowed enum values: incidents
default: incidents
{
"data": {
"type": "incidents",
"attributes": {
"title": "Example-Incident",
"customer_impacted": false,
"fields": {
"state": {
"type": "dropdown",
"value": "resolved"
}
}
},
"relationships": {
"commander_user": {
"data": {
"type": "users",
"id": "string"
}
}
}
}
}
CREATED
Response with an incident.
항목
유형
설명
data [required]
object
Incident data from a response.
attributes
object
The incident's attributes from a response.
archived
date-time
Timestamp of when the incident was archived.
case_id
int64
The incident case id.
created
date-time
Timestamp when the incident was created.
customer_impact_duration
int64
Length of the incident's customer impact in seconds.
Equals the difference between customer_impact_start
and customer_impact_end
.
customer_impact_end
date-time
Timestamp when customers were no longer impacted by the incident.
customer_impact_scope
string
A summary of the impact customers experienced during the incident.
customer_impact_start
date-time
Timestamp when customers began being impacted by the incident.
customer_impacted
boolean
A flag indicating whether the incident caused customer impact.
detected
date-time
Timestamp when the incident was detected.
fields
object
A condensed view of the user-defined fields attached to incidents.
<any-key>
<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
object
A field with a single value selected.
type
enum
Type of the single value field definitions.
Allowed enum values: dropdown,textbox
default: dropdown
value
string
The single value selected for this field.
Option 2
object
A field with potentially multiple values selected.
type
enum
Type of the multiple value field definitions.
Allowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
[string]
The multiple values selected for this field.
modified
date-time
Timestamp when the incident was last modified.
non_datadog_creator
object
Incident's non Datadog creator.
image_48_px
string
Non Datadog creator 48px
image.
name
string
Non Datadog creator name.
notification_handles
[object]
Notification handles that will be notified of the incident during update.
display_name
string
The name of the notified handle.
handle
string
The handle used for the notification. This includes an email address, Slack channel, or workflow.
public_id
int64
The monotonically increasing integer ID for the incident.
resolved
date-time
Timestamp when the incident's state was last changed from active or stable to resolved or completed.
severity
enum
The incident severity.
Allowed enum values: UNKNOWN,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5
state
string
The state incident.
time_to_detect
int64
The amount of time in seconds to detect the incident.
Equals the difference between customer_impact_start
and detected
.
time_to_internal_response
int64
The amount of time in seconds to call incident after detection. Equals the difference of detected
and created
.
time_to_repair
int64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end
and detected
.
time_to_resolve
int64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created
and resolved
.
title [required]
string
The title of the incident, which summarizes what happened.
visibility
string
The incident visibility status.
id [required]
string
The incident's ID.
relationships
object
The incident's relationships from a response.
attachments
object
A relationship reference for attachments.
data [required]
[object]
An array of incident attachments.
id [required]
string
A unique identifier that represents the attachment.
type [required]
enum
The incident attachment resource type.
Allowed enum values: incident_attachments
default: incident_attachments
commander_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
created_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
impacts
object
Relationship to impacts.
data [required]
[object]
An array of incident impacts.
id [required]
string
A unique identifier that represents the impact.
type [required]
enum
The incident impacts type.
Allowed enum values: incident_impacts
integrations
object
A relationship reference for multiple integration metadata objects.
data [required]
[object]
Integration metadata relationship array
id [required]
string
A unique identifier that represents the integration metadata.
type [required]
enum
Integration metadata resource type.
Allowed enum values: incident_integrations
default: incident_integrations
last_modified_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
responders
object
Relationship to incident responders.
data [required]
[object]
An array of incident responders.
id [required]
string
A unique identifier that represents the responder.
type [required]
enum
The incident responders type.
Allowed enum values: incident_responders
user_defined_fields
object
Relationship to incident user defined fields.
data [required]
[object]
An array of user defined fields.
id [required]
string
A unique identifier that represents the responder.
type [required]
enum
The incident user defined fields type.
Allowed enum values: user_defined_field
type [required]
enum
Incident resource type.
Allowed enum values: incidents
default: incidents
included
[ <oneOf>]
Included related resources that the user requested.
Option 1
object
User object returned by the API.
attributes
object
Attributes of user object returned by the API.
string
Email of the user.
handle
string
Handle of the user.
icon
string
URL of the user's icon.
name
string
Name of the user.
uuid
string
UUID of the user.
id
string
ID of the user.
type
enum
Users resource type.
Allowed enum values: users
default: users
Option 2
object
A single incident attachment.
attributes [required]
<oneOf>
The attributes object for an attachment.
Option 1
object
The attributes object for a postmortem attachment.
attachment [required]
object
The postmortem attachment.
documentUrl [required]
string
The URL of this notebook attachment.
title [required]
string
The title of this postmortem attachment.
attachment_type [required]
enum
The type of postmortem attachment attributes.
Allowed enum values: postmortem
default: postmortem
Option 2
object
The attributes object for a link attachment.
attachment [required]
object
The link attachment.
documentUrl [required]
string
The URL of this link attachment.
title [required]
string
The title of this link attachment.
attachment_type [required]
enum
The type of link attachment attributes.
Allowed enum values: link
default: link
modified
date-time
Timestamp when the incident attachment link was last modified.
id [required]
string
A unique identifier that represents the incident attachment.
relationships [required]
object
The incident attachment's relationships.
last_modified_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
type [required]
enum
The incident attachment resource type.
Allowed enum values: incident_attachments
default: incident_attachments
{
"data": {
"attributes": {
"archived": "2019-09-19T10:00:00.000Z",
"case_id": "integer",
"created": "2019-09-19T10:00:00.000Z",
"customer_impact_duration": "integer",
"customer_impact_end": "2019-09-19T10:00:00.000Z",
"customer_impact_scope": "An example customer impact scope",
"customer_impact_start": "2019-09-19T10:00:00.000Z",
"customer_impacted": false,
"detected": "2019-09-19T10:00:00.000Z",
"fields": {
"<any-key>": "undefined"
},
"modified": "2019-09-19T10:00:00.000Z",
"non_datadog_creator": {
"image_48_px": "string",
"name": "string"
},
"notification_handles": [
{
"display_name": "Jane Doe",
"handle": "@test.user@test.com"
}
],
"public_id": 1,
"resolved": "2019-09-19T10:00:00.000Z",
"severity": "UNKNOWN",
"state": "string",
"time_to_detect": "integer",
"time_to_internal_response": "integer",
"time_to_repair": "integer",
"time_to_resolve": "integer",
"title": "A test incident title",
"visibility": "string"
},
"id": "00000000-0000-0000-1234-000000000000",
"relationships": {
"attachments": {
"data": [
{
"id": "00000000-0000-abcd-1000-000000000000",
"type": "incident_attachments"
}
]
},
"commander_user": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
},
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"impacts": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "incident_impacts"
}
]
},
"integrations": {
"data": [
{
"id": "00000000-abcd-0001-0000-000000000000",
"type": "incident_integrations"
}
]
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"responders": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "incident_responders"
}
]
},
"user_defined_fields": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "user_defined_field"
}
]
}
},
"type": "incidents"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"type": "incidents",
"attributes": {
"title": "Example-Incident",
"customer_impacted": false,
"fields": {
"state": {
"type": "dropdown",
"value": "resolved"
}
}
},
"relationships": {
"commander_user": {
"data": {
"type": "users",
"id": "string"
}
}
}
}
}
EOF
// Create an incident returns "CREATED" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "user" in the system
UserDataID := os.Getenv("USER_DATA_ID")
body := datadogV2.IncidentCreateRequest{
Data: datadogV2.IncidentCreateData{
Type: datadogV2.INCIDENTTYPE_INCIDENTS,
Attributes: datadogV2.IncidentCreateAttributes{
Title: "Example-Incident",
CustomerImpacted: false,
Fields: map[string]datadogV2.IncidentFieldAttributes{
"state": datadogV2.IncidentFieldAttributes{
IncidentFieldAttributesSingleValue: &datadogV2.IncidentFieldAttributesSingleValue{
Type: datadogV2.INCIDENTFIELDATTRIBUTESSINGLEVALUETYPE_DROPDOWN.Ptr(),
Value: *datadog.NewNullableString(datadog.PtrString("resolved")),
}},
},
},
Relationships: &datadogV2.IncidentCreateRelationships{
CommanderUser: *datadogV2.NewNullableNullableRelationshipToUser(&datadogV2.NullableRelationshipToUser{
Data: *datadogV2.NewNullableNullableRelationshipToUserData(&datadogV2.NullableRelationshipToUserData{
Type: datadogV2.USERSTYPE_USERS,
Id: UserDataID,
}),
}),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.CreateIncident", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewIncidentsApi(apiClient)
resp, r, err := api.CreateIncident(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IncidentsApi.CreateIncident`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `IncidentsApi.CreateIncident`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Create an incident returns "CREATED" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentCreateAttributes;
import com.datadog.api.client.v2.model.IncidentCreateData;
import com.datadog.api.client.v2.model.IncidentCreateRelationships;
import com.datadog.api.client.v2.model.IncidentCreateRequest;
import com.datadog.api.client.v2.model.IncidentFieldAttributes;
import com.datadog.api.client.v2.model.IncidentFieldAttributesSingleValue;
import com.datadog.api.client.v2.model.IncidentFieldAttributesSingleValueType;
import com.datadog.api.client.v2.model.IncidentResponse;
import com.datadog.api.client.v2.model.IncidentType;
import com.datadog.api.client.v2.model.NullableRelationshipToUser;
import com.datadog.api.client.v2.model.NullableRelationshipToUserData;
import com.datadog.api.client.v2.model.UsersType;
import java.util.Map;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createIncident", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
// there is a valid "user" in the system
String USER_DATA_ID = System.getenv("USER_DATA_ID");
IncidentCreateRequest body =
new IncidentCreateRequest()
.data(
new IncidentCreateData()
.type(IncidentType.INCIDENTS)
.attributes(
new IncidentCreateAttributes()
.title("Example-Incident")
.customerImpacted(false)
.fields(
Map.ofEntries(
Map.entry(
"state",
new IncidentFieldAttributes(
new IncidentFieldAttributesSingleValue()
.type(
IncidentFieldAttributesSingleValueType.DROPDOWN)
.value("resolved"))))))
.relationships(
new IncidentCreateRelationships()
.commanderUser(
new NullableRelationshipToUser()
.data(
new NullableRelationshipToUserData()
.type(UsersType.USERS)
.id(USER_DATA_ID)))));
try {
IncidentResponse result = apiInstance.createIncident(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#createIncident");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
"""
Create an incident returns "CREATED" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_create_attributes import IncidentCreateAttributes
from datadog_api_client.v2.model.incident_create_data import IncidentCreateData
from datadog_api_client.v2.model.incident_create_relationships import IncidentCreateRelationships
from datadog_api_client.v2.model.incident_create_request import IncidentCreateRequest
from datadog_api_client.v2.model.incident_field_attributes_single_value import IncidentFieldAttributesSingleValue
from datadog_api_client.v2.model.incident_field_attributes_single_value_type import (
IncidentFieldAttributesSingleValueType,
)
from datadog_api_client.v2.model.incident_type import IncidentType
from datadog_api_client.v2.model.nullable_relationship_to_user import NullableRelationshipToUser
from datadog_api_client.v2.model.nullable_relationship_to_user_data import NullableRelationshipToUserData
from datadog_api_client.v2.model.users_type import UsersType
# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]
body = IncidentCreateRequest(
data=IncidentCreateData(
type=IncidentType.INCIDENTS,
attributes=IncidentCreateAttributes(
title="Example-Incident",
customer_impacted=False,
fields=dict(
state=IncidentFieldAttributesSingleValue(
type=IncidentFieldAttributesSingleValueType.DROPDOWN,
value="resolved",
),
),
),
relationships=IncidentCreateRelationships(
commander_user=NullableRelationshipToUser(
data=NullableRelationshipToUserData(
type=UsersType.USERS,
id=USER_DATA_ID,
),
),
),
),
)
configuration = Configuration()
configuration.unstable_operations["create_incident"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.create_incident(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Create an incident returns "CREATED" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.create_incident".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
# there is a valid "user" in the system
USER_DATA_ID = ENV["USER_DATA_ID"]
body = DatadogAPIClient::V2::IncidentCreateRequest.new({
data: DatadogAPIClient::V2::IncidentCreateData.new({
type: DatadogAPIClient::V2::IncidentType::INCIDENTS,
attributes: DatadogAPIClient::V2::IncidentCreateAttributes.new({
title: "Example-Incident",
customer_impacted: false,
fields: {
state: DatadogAPIClient::V2::IncidentFieldAttributesSingleValue.new({
type: DatadogAPIClient::V2::IncidentFieldAttributesSingleValueType::DROPDOWN,
value: "resolved",
}),
},
}),
relationships: DatadogAPIClient::V2::IncidentCreateRelationships.new({
commander_user: DatadogAPIClient::V2::NullableRelationshipToUser.new({
data: DatadogAPIClient::V2::NullableRelationshipToUserData.new({
type: DatadogAPIClient::V2::UsersType::USERS,
id: USER_DATA_ID,
}),
}),
}),
}),
})
p api_instance.create_incident(body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Create an incident returns "CREATED" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_incidents::IncidentsAPI;
use datadog_api_client::datadogV2::model::IncidentCreateAttributes;
use datadog_api_client::datadogV2::model::IncidentCreateData;
use datadog_api_client::datadogV2::model::IncidentCreateRelationships;
use datadog_api_client::datadogV2::model::IncidentCreateRequest;
use datadog_api_client::datadogV2::model::IncidentFieldAttributes;
use datadog_api_client::datadogV2::model::IncidentFieldAttributesSingleValue;
use datadog_api_client::datadogV2::model::IncidentFieldAttributesSingleValueType;
use datadog_api_client::datadogV2::model::IncidentType;
use datadog_api_client::datadogV2::model::NullableRelationshipToUser;
use datadog_api_client::datadogV2::model::NullableRelationshipToUserData;
use datadog_api_client::datadogV2::model::UsersType;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
// there is a valid "user" in the system
let user_data_id = std::env::var("USER_DATA_ID").unwrap();
let body = IncidentCreateRequest::new(
IncidentCreateData::new(
IncidentCreateAttributes::new(false, "Example-Incident".to_string()).fields(
BTreeMap::from([(
"state".to_string(),
IncidentFieldAttributes::IncidentFieldAttributesSingleValue(Box::new(
IncidentFieldAttributesSingleValue::new()
.type_(IncidentFieldAttributesSingleValueType::DROPDOWN)
.value(Some("resolved".to_string())),
)),
)]),
),
IncidentType::INCIDENTS,
)
.relationships(IncidentCreateRelationships::new(Some(
NullableRelationshipToUser::new(Some(NullableRelationshipToUserData::new(
user_data_id.clone(),
UsersType::USERS,
))),
))),
);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.CreateIncident", true);
let api = IncidentsAPI::with_config(configuration);
let resp = api.create_incident(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Create an incident returns "CREATED" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations["v2.createIncident"] = true;
const apiInstance = new v2.IncidentsApi(configuration);
// there is a valid "user" in the system
const USER_DATA_ID = process.env.USER_DATA_ID as string;
const params: v2.IncidentsApiCreateIncidentRequest = {
body: {
data: {
type: "incidents",
attributes: {
title: "Example-Incident",
customerImpacted: false,
fields: {
state: {
type: "dropdown",
value: "resolved",
},
},
},
relationships: {
commanderUser: {
data: {
type: "users",
id: USER_DATA_ID,
},
},
},
},
},
};
apiInstance
.createIncident(params)
.then((data: v2.IncidentResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
Note: This endpoint is in public beta. If you have any feedback, contact Datadog support.
GET https://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}https://api.datadoghq.eu/api/v2/incidents/{incident_id}https://api.ddog-gov.com/api/v2/incidents/{incident_id}https://api.datadoghq.com/api/v2/incidents/{incident_id}https://api.us3.datadoghq.com/api/v2/incidents/{incident_id}https://api.us5.datadoghq.com/api/v2/incidents/{incident_id}
Get the details of an incident by incident_id
.
This endpoint requires the incident_read
permission.
OAuth apps require the incident_read
authorization scope to access this endpoint.
이름
유형
설명
incident_id [required]
string
The UUID of the incident.
이름
유형
설명
include
array
Specifies which types of related objects should be included in the response.
OK
Response with an incident.
항목
유형
설명
data [required]
object
Incident data from a response.
attributes
object
The incident's attributes from a response.
archived
date-time
Timestamp of when the incident was archived.
case_id
int64
The incident case id.
created
date-time
Timestamp when the incident was created.
customer_impact_duration
int64
Length of the incident's customer impact in seconds.
Equals the difference between customer_impact_start
and customer_impact_end
.
customer_impact_end
date-time
Timestamp when customers were no longer impacted by the incident.
customer_impact_scope
string
A summary of the impact customers experienced during the incident.
customer_impact_start
date-time
Timestamp when customers began being impacted by the incident.
customer_impacted
boolean
A flag indicating whether the incident caused customer impact.
detected
date-time
Timestamp when the incident was detected.
fields
object
A condensed view of the user-defined fields attached to incidents.
<any-key>
<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
object
A field with a single value selected.
type
enum
Type of the single value field definitions.
Allowed enum values: dropdown,textbox
default: dropdown
value
string
The single value selected for this field.
Option 2
object
A field with potentially multiple values selected.
type
enum
Type of the multiple value field definitions.
Allowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
[string]
The multiple values selected for this field.
modified
date-time
Timestamp when the incident was last modified.
non_datadog_creator
object
Incident's non Datadog creator.
image_48_px
string
Non Datadog creator 48px
image.
name
string
Non Datadog creator name.
notification_handles
[object]
Notification handles that will be notified of the incident during update.
display_name
string
The name of the notified handle.
handle
string
The handle used for the notification. This includes an email address, Slack channel, or workflow.
public_id
int64
The monotonically increasing integer ID for the incident.
resolved
date-time
Timestamp when the incident's state was last changed from active or stable to resolved or completed.
severity
enum
The incident severity.
Allowed enum values: UNKNOWN,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5
state
string
The state incident.
time_to_detect
int64
The amount of time in seconds to detect the incident.
Equals the difference between customer_impact_start
and detected
.
time_to_internal_response
int64
The amount of time in seconds to call incident after detection. Equals the difference of detected
and created
.
time_to_repair
int64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end
and detected
.
time_to_resolve
int64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created
and resolved
.
title [required]
string
The title of the incident, which summarizes what happened.
visibility
string
The incident visibility status.
id [required]
string
The incident's ID.
relationships
object
The incident's relationships from a response.
attachments
object
A relationship reference for attachments.
data [required]
[object]
An array of incident attachments.
id [required]
string
A unique identifier that represents the attachment.
type [required]
enum
The incident attachment resource type.
Allowed enum values: incident_attachments
default: incident_attachments
commander_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
created_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
impacts
object
Relationship to impacts.
data [required]
[object]
An array of incident impacts.
id [required]
string
A unique identifier that represents the impact.
type [required]
enum
The incident impacts type.
Allowed enum values: incident_impacts
integrations
object
A relationship reference for multiple integration metadata objects.
data [required]
[object]
Integration metadata relationship array
id [required]
string
A unique identifier that represents the integration metadata.
type [required]
enum
Integration metadata resource type.
Allowed enum values: incident_integrations
default: incident_integrations
last_modified_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
responders
object
Relationship to incident responders.
data [required]
[object]
An array of incident responders.
id [required]
string
A unique identifier that represents the responder.
type [required]
enum
The incident responders type.
Allowed enum values: incident_responders
user_defined_fields
object
Relationship to incident user defined fields.
data [required]
[object]
An array of user defined fields.
id [required]
string
A unique identifier that represents the responder.
type [required]
enum
The incident user defined fields type.
Allowed enum values: user_defined_field
type [required]
enum
Incident resource type.
Allowed enum values: incidents
default: incidents
included
[ <oneOf>]
Included related resources that the user requested.
Option 1
object
User object returned by the API.
attributes
object
Attributes of user object returned by the API.
string
Email of the user.
handle
string
Handle of the user.
icon
string
URL of the user's icon.
name
string
Name of the user.
uuid
string
UUID of the user.
id
string
ID of the user.
type
enum
Users resource type.
Allowed enum values: users
default: users
Option 2
object
A single incident attachment.
attributes [required]
<oneOf>
The attributes object for an attachment.
Option 1
object
The attributes object for a postmortem attachment.
attachment [required]
object
The postmortem attachment.
documentUrl [required]
string
The URL of this notebook attachment.
title [required]
string
The title of this postmortem attachment.
attachment_type [required]
enum
The type of postmortem attachment attributes.
Allowed enum values: postmortem
default: postmortem
Option 2
object
The attributes object for a link attachment.
attachment [required]
object
The link attachment.
documentUrl [required]
string
The URL of this link attachment.
title [required]
string
The title of this link attachment.
attachment_type [required]
enum
The type of link attachment attributes.
Allowed enum values: link
default: link
modified
date-time
Timestamp when the incident attachment link was last modified.
id [required]
string
A unique identifier that represents the incident attachment.
relationships [required]
object
The incident attachment's relationships.
last_modified_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
type [required]
enum
The incident attachment resource type.
Allowed enum values: incident_attachments
default: incident_attachments
{
"data": {
"attributes": {
"archived": "2019-09-19T10:00:00.000Z",
"case_id": "integer",
"created": "2019-09-19T10:00:00.000Z",
"customer_impact_duration": "integer",
"customer_impact_end": "2019-09-19T10:00:00.000Z",
"customer_impact_scope": "An example customer impact scope",
"customer_impact_start": "2019-09-19T10:00:00.000Z",
"customer_impacted": false,
"detected": "2019-09-19T10:00:00.000Z",
"fields": {
"<any-key>": "undefined"
},
"modified": "2019-09-19T10:00:00.000Z",
"non_datadog_creator": {
"image_48_px": "string",
"name": "string"
},
"notification_handles": [
{
"display_name": "Jane Doe",
"handle": "@test.user@test.com"
}
],
"public_id": 1,
"resolved": "2019-09-19T10:00:00.000Z",
"severity": "UNKNOWN",
"state": "string",
"time_to_detect": "integer",
"time_to_internal_response": "integer",
"time_to_repair": "integer",
"time_to_resolve": "integer",
"title": "A test incident title",
"visibility": "string"
},
"id": "00000000-0000-0000-1234-000000000000",
"relationships": {
"attachments": {
"data": [
{
"id": "00000000-0000-abcd-1000-000000000000",
"type": "incident_attachments"
}
]
},
"commander_user": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
},
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"impacts": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "incident_impacts"
}
]
},
"integrations": {
"data": [
{
"id": "00000000-abcd-0001-0000-000000000000",
"type": "incident_integrations"
}
]
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"responders": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "incident_responders"
}
]
},
"user_defined_fields": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "user_defined_field"
}
]
}
},
"type": "incidents"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export incident_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents/${incident_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get the details of an incident returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
# there is a valid "incident" in the system
INCIDENT_DATA_ID = environ["INCIDENT_DATA_ID"]
configuration = Configuration()
configuration.unstable_operations["get_incident"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.get_incident(
incident_id=INCIDENT_DATA_ID,
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get the details of an incident returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.get_incident".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
# there is a valid "incident" in the system
INCIDENT_DATA_ID = ENV["INCIDENT_DATA_ID"]
p api_instance.get_incident(INCIDENT_DATA_ID)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get the details of an incident returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "incident" in the system
IncidentDataID := os.Getenv("INCIDENT_DATA_ID")
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.GetIncident", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewIncidentsApi(apiClient)
resp, r, err := api.GetIncident(ctx, IncidentDataID, *datadogV2.NewGetIncidentOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IncidentsApi.GetIncident`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `IncidentsApi.GetIncident`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get the details of an incident returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.getIncident", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
// there is a valid "incident" in the system
String INCIDENT_DATA_ID = System.getenv("INCIDENT_DATA_ID");
try {
IncidentResponse result = apiInstance.getIncident(INCIDENT_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#getIncident");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// Get the details of an incident returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_incidents::GetIncidentOptionalParams;
use datadog_api_client::datadogV2::api_incidents::IncidentsAPI;
#[tokio::main]
async fn main() {
// there is a valid "incident" in the system
let incident_data_id = std::env::var("INCIDENT_DATA_ID").unwrap();
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.GetIncident", true);
let api = IncidentsAPI::with_config(configuration);
let resp = api
.get_incident(
incident_data_id.clone(),
GetIncidentOptionalParams::default(),
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Get the details of an incident returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations["v2.getIncident"] = true;
const apiInstance = new v2.IncidentsApi(configuration);
// there is a valid "incident" in the system
const INCIDENT_DATA_ID = process.env.INCIDENT_DATA_ID as string;
const params: v2.IncidentsApiGetIncidentRequest = {
incidentId: INCIDENT_DATA_ID,
};
apiInstance
.getIncident(params)
.then((data: v2.IncidentResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
Note: This endpoint is in public beta. If you have any feedback, contact Datadog support.
PATCH https://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}https://api.datadoghq.eu/api/v2/incidents/{incident_id}https://api.ddog-gov.com/api/v2/incidents/{incident_id}https://api.datadoghq.com/api/v2/incidents/{incident_id}https://api.us3.datadoghq.com/api/v2/incidents/{incident_id}https://api.us5.datadoghq.com/api/v2/incidents/{incident_id}
Updates an incident. Provide only the attributes that should be updated as this request is a partial update.
This endpoint requires the incident_write
permission.
OAuth apps require the incident_write
authorization scope to access this endpoint.
이름
유형
설명
incident_id [required]
string
The UUID of the incident.
이름
유형
설명
include
array
Specifies which types of related objects should be included in the response.
Incident Payload.
항목
유형
설명
data [required]
object
Incident data for an update request.
attributes
object
The incident's attributes for an update request.
customer_impact_end
date-time
Timestamp when customers were no longer impacted by the incident.
customer_impact_scope
string
A summary of the impact customers experienced during the incident.
customer_impact_start
date-time
Timestamp when customers began being impacted by the incident.
customer_impacted
boolean
A flag indicating whether the incident caused customer impact.
detected
date-time
Timestamp when the incident was detected.
fields
object
A condensed view of the user-defined fields for which to update selections.
<any-key>
<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
object
A field with a single value selected.
type
enum
Type of the single value field definitions.
Allowed enum values: dropdown,textbox
default: dropdown
value
string
The single value selected for this field.
Option 2
object
A field with potentially multiple values selected.
type
enum
Type of the multiple value field definitions.
Allowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
[string]
The multiple values selected for this field.
notification_handles
[object]
Notification handles that will be notified of the incident during update.
display_name
string
The name of the notified handle.
handle
string
The handle used for the notification. This includes an email address, Slack channel, or workflow.
title
string
The title of the incident, which summarizes what happened.
id [required]
string
The incident's ID.
relationships
object
The incident's relationships for an update request.
commander_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
integrations
object
A relationship reference for multiple integration metadata objects.
data [required]
[object]
Integration metadata relationship array
id [required]
string
A unique identifier that represents the integration metadata.
type [required]
enum
Integration metadata resource type.
Allowed enum values: incident_integrations
default: incident_integrations
postmortem
object
A relationship reference for postmortems.
data [required]
object
The postmortem relationship data.
id [required]
string
A unique identifier that represents the postmortem.
type [required]
enum
Incident postmortem resource type.
Allowed enum values: incident_postmortems
default: incident_postmortems
type [required]
enum
Incident resource type.
Allowed enum values: incidents
default: incidents
{
"data": {
"id": "00000000-0000-0000-1234-000000000000",
"type": "incidents",
"relationships": {
"commander_user": {
"data": {
"id": "string",
"type": "users"
}
}
}
}
}
{
"data": {
"id": "00000000-0000-0000-1234-000000000000",
"type": "incidents",
"relationships": {
"commander_user": {
"data": null
}
}
}
}
{
"data": {
"id": "00000000-0000-0000-1234-000000000000",
"type": "incidents",
"attributes": {
"fields": {
"state": {
"type": "dropdown",
"value": "resolved"
}
},
"title": "A test incident title-updated"
}
}
}
OK
Response with an incident.
항목
유형
설명
data [required]
object
Incident data from a response.
attributes
object
The incident's attributes from a response.
archived
date-time
Timestamp of when the incident was archived.
case_id
int64
The incident case id.
created
date-time
Timestamp when the incident was created.
customer_impact_duration
int64
Length of the incident's customer impact in seconds.
Equals the difference between customer_impact_start
and customer_impact_end
.
customer_impact_end
date-time
Timestamp when customers were no longer impacted by the incident.
customer_impact_scope
string
A summary of the impact customers experienced during the incident.
customer_impact_start
date-time
Timestamp when customers began being impacted by the incident.
customer_impacted
boolean
A flag indicating whether the incident caused customer impact.
detected
date-time
Timestamp when the incident was detected.
fields
object
A condensed view of the user-defined fields attached to incidents.
<any-key>
<oneOf>
Dynamic fields for which selections can be made, with field names as keys.
Option 1
object
A field with a single value selected.
type
enum
Type of the single value field definitions.
Allowed enum values: dropdown,textbox
default: dropdown
value
string
The single value selected for this field.
Option 2
object
A field with potentially multiple values selected.
type
enum
Type of the multiple value field definitions.
Allowed enum values: multiselect,textarray,metrictag,autocomplete
default: multiselect
value
[string]
The multiple values selected for this field.
modified
date-time
Timestamp when the incident was last modified.
non_datadog_creator
object
Incident's non Datadog creator.
image_48_px
string
Non Datadog creator 48px
image.
name
string
Non Datadog creator name.
notification_handles
[object]
Notification handles that will be notified of the incident during update.
display_name
string
The name of the notified handle.
handle
string
The handle used for the notification. This includes an email address, Slack channel, or workflow.
public_id
int64
The monotonically increasing integer ID for the incident.
resolved
date-time
Timestamp when the incident's state was last changed from active or stable to resolved or completed.
severity
enum
The incident severity.
Allowed enum values: UNKNOWN,SEV-1,SEV-2,SEV-3,SEV-4,SEV-5
state
string
The state incident.
time_to_detect
int64
The amount of time in seconds to detect the incident.
Equals the difference between customer_impact_start
and detected
.
time_to_internal_response
int64
The amount of time in seconds to call incident after detection. Equals the difference of detected
and created
.
time_to_repair
int64
The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end
and detected
.
time_to_resolve
int64
The amount of time in seconds to resolve the incident after it was created. Equals the difference between created
and resolved
.
title [required]
string
The title of the incident, which summarizes what happened.
visibility
string
The incident visibility status.
id [required]
string
The incident's ID.
relationships
object
The incident's relationships from a response.
attachments
object
A relationship reference for attachments.
data [required]
[object]
An array of incident attachments.
id [required]
string
A unique identifier that represents the attachment.
type [required]
enum
The incident attachment resource type.
Allowed enum values: incident_attachments
default: incident_attachments
commander_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
created_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
impacts
object
Relationship to impacts.
data [required]
[object]
An array of incident impacts.
id [required]
string
A unique identifier that represents the impact.
type [required]
enum
The incident impacts type.
Allowed enum values: incident_impacts
integrations
object
A relationship reference for multiple integration metadata objects.
data [required]
[object]
Integration metadata relationship array
id [required]
string
A unique identifier that represents the integration metadata.
type [required]
enum
Integration metadata resource type.
Allowed enum values: incident_integrations
default: incident_integrations
last_modified_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
responders
object
Relationship to incident responders.
data [required]
[object]
An array of incident responders.
id [required]
string
A unique identifier that represents the responder.
type [required]
enum
The incident responders type.
Allowed enum values: incident_responders
user_defined_fields
object
Relationship to incident user defined fields.
data [required]
[object]
An array of user defined fields.
id [required]
string
A unique identifier that represents the responder.
type [required]
enum
The incident user defined fields type.
Allowed enum values: user_defined_field
type [required]
enum
Incident resource type.
Allowed enum values: incidents
default: incidents
included
[ <oneOf>]
Included related resources that the user requested.
Option 1
object
User object returned by the API.
attributes
object
Attributes of user object returned by the API.
string
Email of the user.
handle
string
Handle of the user.
icon
string
URL of the user's icon.
name
string
Name of the user.
uuid
string
UUID of the user.
id
string
ID of the user.
type
enum
Users resource type.
Allowed enum values: users
default: users
Option 2
object
A single incident attachment.
attributes [required]
<oneOf>
The attributes object for an attachment.
Option 1
object
The attributes object for a postmortem attachment.
attachment [required]
object
The postmortem attachment.
documentUrl [required]
string
The URL of this notebook attachment.
title [required]
string
The title of this postmortem attachment.
attachment_type [required]
enum
The type of postmortem attachment attributes.
Allowed enum values: postmortem
default: postmortem
Option 2
object
The attributes object for a link attachment.
attachment [required]
object
The link attachment.
documentUrl [required]
string
The URL of this link attachment.
title [required]
string
The title of this link attachment.
attachment_type [required]
enum
The type of link attachment attributes.
Allowed enum values: link
default: link
modified
date-time
Timestamp when the incident attachment link was last modified.
id [required]
string
A unique identifier that represents the incident attachment.
relationships [required]
object
The incident attachment's relationships.
last_modified_by_user
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
type [required]
enum
The incident attachment resource type.
Allowed enum values: incident_attachments
default: incident_attachments
{
"data": {
"attributes": {
"archived": "2019-09-19T10:00:00.000Z",
"case_id": "integer",
"created": "2019-09-19T10:00:00.000Z",
"customer_impact_duration": "integer",
"customer_impact_end": "2019-09-19T10:00:00.000Z",
"customer_impact_scope": "An example customer impact scope",
"customer_impact_start": "2019-09-19T10:00:00.000Z",
"customer_impacted": false,
"detected": "2019-09-19T10:00:00.000Z",
"fields": {
"<any-key>": "undefined"
},
"modified": "2019-09-19T10:00:00.000Z",
"non_datadog_creator": {
"image_48_px": "string",
"name": "string"
},
"notification_handles": [
{
"display_name": "Jane Doe",
"handle": "@test.user@test.com"
}
],
"public_id": 1,
"resolved": "2019-09-19T10:00:00.000Z",
"severity": "UNKNOWN",
"state": "string",
"time_to_detect": "integer",
"time_to_internal_response": "integer",
"time_to_repair": "integer",
"time_to_resolve": "integer",
"title": "A test incident title",
"visibility": "string"
},
"id": "00000000-0000-0000-1234-000000000000",
"relationships": {
"attachments": {
"data": [
{
"id": "00000000-0000-abcd-1000-000000000000",
"type": "incident_attachments"
}
]
},
"commander_user": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
},
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"impacts": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "incident_impacts"
}
]
},
"integrations": {
"data": [
{
"id": "00000000-abcd-0001-0000-000000000000",
"type": "incident_integrations"
}
]
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"responders": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "incident_responders"
}
]
},
"user_defined_fields": {
"data": [
{
"id": "00000000-0000-0000-2345-000000000000",
"type": "user_defined_field"
}
]
}
},
"type": "incidents"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export incident_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents/${incident_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"id": "00000000-0000-0000-1234-000000000000",
"type": "incidents",
"relationships": {
"commander_user": {
"data": {
"id": "string",
"type": "users"
}
}
}
}
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents/${incident_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"id": "00000000-0000-0000-1234-000000000000",
"type": "incidents",
"relationships": {
"commander_user": {
"data": null
}
}
}
}
EOF
# Path parameters
export incident_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents/${incident_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"id": "00000000-0000-0000-1234-000000000000",
"type": "incidents",
"attributes": {
"fields": {
"state": {
"type": "dropdown",
"value": "resolved"
}
},
"title": "A test incident title-updated"
}
}
}
EOF
// Add commander to an incident returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "incident" in the system
IncidentDataID := os.Getenv("INCIDENT_DATA_ID")
// there is a valid "user" in the system
UserDataID := os.Getenv("USER_DATA_ID")
body := datadogV2.IncidentUpdateRequest{
Data: datadogV2.IncidentUpdateData{
Id: IncidentDataID,
Type: datadogV2.INCIDENTTYPE_INCIDENTS,
Relationships: &datadogV2.IncidentUpdateRelationships{
CommanderUser: *datadogV2.NewNullableNullableRelationshipToUser(&datadogV2.NullableRelationshipToUser{
Data: *datadogV2.NewNullableNullableRelationshipToUserData(&datadogV2.NullableRelationshipToUserData{
Id: UserDataID,
Type: datadogV2.USERSTYPE_USERS,
}),
}),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.UpdateIncident", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewIncidentsApi(apiClient)
resp, r, err := api.UpdateIncident(ctx, IncidentDataID, body, *datadogV2.NewUpdateIncidentOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IncidentsApi.UpdateIncident`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `IncidentsApi.UpdateIncident`:\n%s\n", responseContent)
}
// Remove commander from an incident returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "incident" in the system
IncidentDataID := os.Getenv("INCIDENT_DATA_ID")
body := datadogV2.IncidentUpdateRequest{
Data: datadogV2.IncidentUpdateData{
Id: IncidentDataID,
Type: datadogV2.INCIDENTTYPE_INCIDENTS,
Relationships: &datadogV2.IncidentUpdateRelationships{
CommanderUser: *datadogV2.NewNullableNullableRelationshipToUser(&datadogV2.NullableRelationshipToUser{
Data: *datadogV2.NewNullableNullableRelationshipToUserData(nil),
}),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.UpdateIncident", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewIncidentsApi(apiClient)
resp, r, err := api.UpdateIncident(ctx, IncidentDataID, body, *datadogV2.NewUpdateIncidentOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IncidentsApi.UpdateIncident`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `IncidentsApi.UpdateIncident`:\n%s\n", responseContent)
}
// Update an existing incident returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "incident" in the system
IncidentDataID := os.Getenv("INCIDENT_DATA_ID")
body := datadogV2.IncidentUpdateRequest{
Data: datadogV2.IncidentUpdateData{
Id: IncidentDataID,
Type: datadogV2.INCIDENTTYPE_INCIDENTS,
Attributes: &datadogV2.IncidentUpdateAttributes{
Fields: map[string]datadogV2.IncidentFieldAttributes{
"state": datadogV2.IncidentFieldAttributes{
IncidentFieldAttributesSingleValue: &datadogV2.IncidentFieldAttributesSingleValue{
Type: datadogV2.INCIDENTFIELDATTRIBUTESSINGLEVALUETYPE_DROPDOWN.Ptr(),
Value: *datadog.NewNullableString(datadog.PtrString("resolved")),
}},
},
Title: datadog.PtrString("A test incident title-updated"),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.UpdateIncident", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewIncidentsApi(apiClient)
resp, r, err := api.UpdateIncident(ctx, IncidentDataID, body, *datadogV2.NewUpdateIncidentOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IncidentsApi.UpdateIncident`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `IncidentsApi.UpdateIncident`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Add commander to an incident returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentResponse;
import com.datadog.api.client.v2.model.IncidentType;
import com.datadog.api.client.v2.model.IncidentUpdateData;
import com.datadog.api.client.v2.model.IncidentUpdateRelationships;
import com.datadog.api.client.v2.model.IncidentUpdateRequest;
import com.datadog.api.client.v2.model.NullableRelationshipToUser;
import com.datadog.api.client.v2.model.NullableRelationshipToUserData;
import com.datadog.api.client.v2.model.UsersType;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateIncident", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
// there is a valid "incident" in the system
String INCIDENT_DATA_ID = System.getenv("INCIDENT_DATA_ID");
// there is a valid "user" in the system
String USER_DATA_ID = System.getenv("USER_DATA_ID");
IncidentUpdateRequest body =
new IncidentUpdateRequest()
.data(
new IncidentUpdateData()
.id(INCIDENT_DATA_ID)
.type(IncidentType.INCIDENTS)
.relationships(
new IncidentUpdateRelationships()
.commanderUser(
new NullableRelationshipToUser()
.data(
new NullableRelationshipToUserData()
.id(USER_DATA_ID)
.type(UsersType.USERS)))));
try {
IncidentResponse result = apiInstance.updateIncident(INCIDENT_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#updateIncident");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// Remove commander from an incident returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentResponse;
import com.datadog.api.client.v2.model.IncidentType;
import com.datadog.api.client.v2.model.IncidentUpdateData;
import com.datadog.api.client.v2.model.IncidentUpdateRelationships;
import com.datadog.api.client.v2.model.IncidentUpdateRequest;
import com.datadog.api.client.v2.model.NullableRelationshipToUser;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateIncident", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
// there is a valid "incident" in the system
String INCIDENT_DATA_ID = System.getenv("INCIDENT_DATA_ID");
IncidentUpdateRequest body =
new IncidentUpdateRequest()
.data(
new IncidentUpdateData()
.id(INCIDENT_DATA_ID)
.type(IncidentType.INCIDENTS)
.relationships(
new IncidentUpdateRelationships()
.commanderUser(new NullableRelationshipToUser().data(null))));
try {
IncidentResponse result = apiInstance.updateIncident(INCIDENT_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#updateIncident");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// Update an existing incident returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentFieldAttributes;
import com.datadog.api.client.v2.model.IncidentFieldAttributesSingleValue;
import com.datadog.api.client.v2.model.IncidentFieldAttributesSingleValueType;
import com.datadog.api.client.v2.model.IncidentResponse;
import com.datadog.api.client.v2.model.IncidentType;
import com.datadog.api.client.v2.model.IncidentUpdateAttributes;
import com.datadog.api.client.v2.model.IncidentUpdateData;
import com.datadog.api.client.v2.model.IncidentUpdateRequest;
import java.util.Map;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateIncident", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
// there is a valid "incident" in the system
String INCIDENT_DATA_ATTRIBUTES_TITLE = System.getenv("INCIDENT_DATA_ATTRIBUTES_TITLE");
String INCIDENT_DATA_ID = System.getenv("INCIDENT_DATA_ID");
IncidentUpdateRequest body =
new IncidentUpdateRequest()
.data(
new IncidentUpdateData()
.id(INCIDENT_DATA_ID)
.type(IncidentType.INCIDENTS)
.attributes(
new IncidentUpdateAttributes()
.fields(
Map.ofEntries(
Map.entry(
"state",
new IncidentFieldAttributes(
new IncidentFieldAttributesSingleValue()
.type(
IncidentFieldAttributesSingleValueType.DROPDOWN)
.value("resolved")))))
.title("A test incident title-updated")));
try {
IncidentResponse result = apiInstance.updateIncident(INCIDENT_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#updateIncident");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
"""
Add commander to an incident returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_type import IncidentType
from datadog_api_client.v2.model.incident_update_data import IncidentUpdateData
from datadog_api_client.v2.model.incident_update_relationships import IncidentUpdateRelationships
from datadog_api_client.v2.model.incident_update_request import IncidentUpdateRequest
from datadog_api_client.v2.model.nullable_relationship_to_user import NullableRelationshipToUser
from datadog_api_client.v2.model.nullable_relationship_to_user_data import NullableRelationshipToUserData
from datadog_api_client.v2.model.users_type import UsersType
# there is a valid "incident" in the system
INCIDENT_DATA_ID = environ["INCIDENT_DATA_ID"]
# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]
body = IncidentUpdateRequest(
data=IncidentUpdateData(
id=INCIDENT_DATA_ID,
type=IncidentType.INCIDENTS,
relationships=IncidentUpdateRelationships(
commander_user=NullableRelationshipToUser(
data=NullableRelationshipToUserData(
id=USER_DATA_ID,
type=UsersType.USERS,
),
),
),
),
)
configuration = Configuration()
configuration.unstable_operations["update_incident"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.update_incident(incident_id=INCIDENT_DATA_ID, body=body)
print(response)
"""
Remove commander from an incident returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_type import IncidentType
from datadog_api_client.v2.model.incident_update_data import IncidentUpdateData
from datadog_api_client.v2.model.incident_update_relationships import IncidentUpdateRelationships
from datadog_api_client.v2.model.incident_update_request import IncidentUpdateRequest
from datadog_api_client.v2.model.nullable_relationship_to_user import NullableRelationshipToUser
# there is a valid "incident" in the system
INCIDENT_DATA_ID = environ["INCIDENT_DATA_ID"]
body = IncidentUpdateRequest(
data=IncidentUpdateData(
id=INCIDENT_DATA_ID,
type=IncidentType.INCIDENTS,
relationships=IncidentUpdateRelationships(
commander_user=NullableRelationshipToUser(
data=None,
),
),
),
)
configuration = Configuration()
configuration.unstable_operations["update_incident"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.update_incident(incident_id=INCIDENT_DATA_ID, body=body)
print(response)
"""
Update an existing incident returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_field_attributes_single_value import IncidentFieldAttributesSingleValue
from datadog_api_client.v2.model.incident_field_attributes_single_value_type import (
IncidentFieldAttributesSingleValueType,
)
from datadog_api_client.v2.model.incident_type import IncidentType
from datadog_api_client.v2.model.incident_update_attributes import IncidentUpdateAttributes
from datadog_api_client.v2.model.incident_update_data import IncidentUpdateData
from datadog_api_client.v2.model.incident_update_request import IncidentUpdateRequest
# there is a valid "incident" in the system
INCIDENT_DATA_ATTRIBUTES_TITLE = environ["INCIDENT_DATA_ATTRIBUTES_TITLE"]
INCIDENT_DATA_ID = environ["INCIDENT_DATA_ID"]
body = IncidentUpdateRequest(
data=IncidentUpdateData(
id=INCIDENT_DATA_ID,
type=IncidentType.INCIDENTS,
attributes=IncidentUpdateAttributes(
fields=dict(
state=IncidentFieldAttributesSingleValue(
type=IncidentFieldAttributesSingleValueType.DROPDOWN,
value="resolved",
),
),
title="A test incident title-updated",
),
),
)
configuration = Configuration()
configuration.unstable_operations["update_incident"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.update_incident(incident_id=INCIDENT_DATA_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Add commander to an incident returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.update_incident".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
# there is a valid "incident" in the system
INCIDENT_DATA_ID = ENV["INCIDENT_DATA_ID"]
# there is a valid "user" in the system
USER_DATA_ID = ENV["USER_DATA_ID"]
body = DatadogAPIClient::V2::IncidentUpdateRequest.new({
data: DatadogAPIClient::V2::IncidentUpdateData.new({
id: INCIDENT_DATA_ID,
type: DatadogAPIClient::V2::IncidentType::INCIDENTS,
relationships: DatadogAPIClient::V2::IncidentUpdateRelationships.new({
commander_user: DatadogAPIClient::V2::NullableRelationshipToUser.new({
data: DatadogAPIClient::V2::NullableRelationshipToUserData.new({
id: USER_DATA_ID,
type: DatadogAPIClient::V2::UsersType::USERS,
}),
}),
}),
}),
})
p api_instance.update_incident(INCIDENT_DATA_ID, body)
# Remove commander from an incident returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.update_incident".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
# there is a valid "incident" in the system
INCIDENT_DATA_ID = ENV["INCIDENT_DATA_ID"]
body = DatadogAPIClient::V2::IncidentUpdateRequest.new({
data: DatadogAPIClient::V2::IncidentUpdateData.new({
id: INCIDENT_DATA_ID,
type: DatadogAPIClient::V2::IncidentType::INCIDENTS,
relationships: DatadogAPIClient::V2::IncidentUpdateRelationships.new({
commander_user: DatadogAPIClient::V2::NullableRelationshipToUser.new({
data: nil,
}),
}),
}),
})
p api_instance.update_incident(INCIDENT_DATA_ID, body)
# Update an existing incident returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.update_incident".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
# there is a valid "incident" in the system
INCIDENT_DATA_ATTRIBUTES_TITLE = ENV["INCIDENT_DATA_ATTRIBUTES_TITLE"]
INCIDENT_DATA_ID = ENV["INCIDENT_DATA_ID"]
body = DatadogAPIClient::V2::IncidentUpdateRequest.new({
data: DatadogAPIClient::V2::IncidentUpdateData.new({
id: INCIDENT_DATA_ID,
type: DatadogAPIClient::V2::IncidentType::INCIDENTS,
attributes: DatadogAPIClient::V2::IncidentUpdateAttributes.new({
fields: {
state: DatadogAPIClient::V2::IncidentFieldAttributesSingleValue.new({
type: DatadogAPIClient::V2::IncidentFieldAttributesSingleValueType::DROPDOWN,
value: "resolved",
}),
},
title: "A test incident title-updated",
}),
}),
})
p api_instance.update_incident(INCIDENT_DATA_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Add commander to an incident returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_incidents::IncidentsAPI;
use datadog_api_client::datadogV2::api_incidents::UpdateIncidentOptionalParams;
use datadog_api_client::datadogV2::model::IncidentType;
use datadog_api_client::datadogV2::model::IncidentUpdateData;
use datadog_api_client::datadogV2::model::IncidentUpdateRelationships;
use datadog_api_client::datadogV2::model::IncidentUpdateRequest;
use datadog_api_client::datadogV2::model::NullableRelationshipToUser;
use datadog_api_client::datadogV2::model::NullableRelationshipToUserData;
use datadog_api_client::datadogV2::model::UsersType;
#[tokio::main]
async fn main() {
// there is a valid "incident" in the system
let incident_data_id = std::env::var("INCIDENT_DATA_ID").unwrap();
// there is a valid "user" in the system
let user_data_id = std::env::var("USER_DATA_ID").unwrap();
let body = IncidentUpdateRequest::new(
IncidentUpdateData::new(incident_data_id.clone(), IncidentType::INCIDENTS).relationships(
IncidentUpdateRelationships::new().commander_user(Some(
NullableRelationshipToUser::new(Some(NullableRelationshipToUserData::new(
user_data_id.clone(),
UsersType::USERS,
))),
)),
),
);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.UpdateIncident", true);
let api = IncidentsAPI::with_config(configuration);
let resp = api
.update_incident(
incident_data_id.clone(),
body,
UpdateIncidentOptionalParams::default(),
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
// Remove commander from an incident returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_incidents::IncidentsAPI;
use datadog_api_client::datadogV2::api_incidents::UpdateIncidentOptionalParams;
use datadog_api_client::datadogV2::model::IncidentType;
use datadog_api_client::datadogV2::model::IncidentUpdateData;
use datadog_api_client::datadogV2::model::IncidentUpdateRelationships;
use datadog_api_client::datadogV2::model::IncidentUpdateRequest;
use datadog_api_client::datadogV2::model::NullableRelationshipToUser;
#[tokio::main]
async fn main() {
// there is a valid "incident" in the system
let incident_data_id = std::env::var("INCIDENT_DATA_ID").unwrap();
let body = IncidentUpdateRequest::new(
IncidentUpdateData::new(incident_data_id.clone(), IncidentType::INCIDENTS).relationships(
IncidentUpdateRelationships::new()
.commander_user(Some(NullableRelationshipToUser::new(None))),
),
);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.UpdateIncident", true);
let api = IncidentsAPI::with_config(configuration);
let resp = api
.update_incident(
incident_data_id.clone(),
body,
UpdateIncidentOptionalParams::default(),
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
// Update an existing incident returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_incidents::IncidentsAPI;
use datadog_api_client::datadogV2::api_incidents::UpdateIncidentOptionalParams;
use datadog_api_client::datadogV2::model::IncidentFieldAttributes;
use datadog_api_client::datadogV2::model::IncidentFieldAttributesSingleValue;
use datadog_api_client::datadogV2::model::IncidentFieldAttributesSingleValueType;
use datadog_api_client::datadogV2::model::IncidentType;
use datadog_api_client::datadogV2::model::IncidentUpdateAttributes;
use datadog_api_client::datadogV2::model::IncidentUpdateData;
use datadog_api_client::datadogV2::model::IncidentUpdateRequest;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
// there is a valid "incident" in the system
let incident_data_id = std::env::var("INCIDENT_DATA_ID").unwrap();
let body = IncidentUpdateRequest::new(
IncidentUpdateData::new(incident_data_id.clone(), IncidentType::INCIDENTS).attributes(
IncidentUpdateAttributes::new()
.fields(BTreeMap::from([(
"state".to_string(),
IncidentFieldAttributes::IncidentFieldAttributesSingleValue(Box::new(
IncidentFieldAttributesSingleValue::new()
.type_(IncidentFieldAttributesSingleValueType::DROPDOWN)
.value(Some("resolved".to_string())),
)),
)]))
.title("A test incident title-updated".to_string()),
),
);
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.UpdateIncident", true);
let api = IncidentsAPI::with_config(configuration);
let resp = api
.update_incident(
incident_data_id.clone(),
body,
UpdateIncidentOptionalParams::default(),
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Add commander to an incident returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations["v2.updateIncident"] = true;
const apiInstance = new v2.IncidentsApi(configuration);
// there is a valid "incident" in the system
const INCIDENT_DATA_ID = process.env.INCIDENT_DATA_ID as string;
// there is a valid "user" in the system
const USER_DATA_ID = process.env.USER_DATA_ID as string;
const params: v2.IncidentsApiUpdateIncidentRequest = {
body: {
data: {
id: INCIDENT_DATA_ID,
type: "incidents",
relationships: {
commanderUser: {
data: {
id: USER_DATA_ID,
type: "users",
},
},
},
},
},
incidentId: INCIDENT_DATA_ID,
};
apiInstance
.updateIncident(params)
.then((data: v2.IncidentResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
/**
* Remove commander from an incident returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations["v2.updateIncident"] = true;
const apiInstance = new v2.IncidentsApi(configuration);
// there is a valid "incident" in the system
const INCIDENT_DATA_ID = process.env.INCIDENT_DATA_ID as string;
const params: v2.IncidentsApiUpdateIncidentRequest = {
body: {
data: {
id: INCIDENT_DATA_ID,
type: "incidents",
relationships: {
commanderUser: {
data: null,
},
},
},
},
incidentId: INCIDENT_DATA_ID,
};
apiInstance
.updateIncident(params)
.then((data: v2.IncidentResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
/**
* Update an existing incident returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations["v2.updateIncident"] = true;
const apiInstance = new v2.IncidentsApi(configuration);
// there is a valid "incident" in the system
const INCIDENT_DATA_ID = process.env.INCIDENT_DATA_ID as string;
const params: v2.IncidentsApiUpdateIncidentRequest = {
body: {
data: {
id: INCIDENT_DATA_ID,
type: "incidents",
attributes: {
fields: {
state: {
type: "dropdown",
value: "resolved",
},
},
title: "A test incident title-updated",
},
},
},
incidentId: INCIDENT_DATA_ID,
};
apiInstance
.updateIncident(params)
.then((data: v2.IncidentResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
Note: This endpoint is in public beta. If you have any feedback, contact Datadog support.
DELETE https://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}https://api.datadoghq.eu/api/v2/incidents/{incident_id}https://api.ddog-gov.com/api/v2/incidents/{incident_id}https://api.datadoghq.com/api/v2/incidents/{incident_id}https://api.us3.datadoghq.com/api/v2/incidents/{incident_id}https://api.us5.datadoghq.com/api/v2/incidents/{incident_id}
Deletes an existing incident from the users organization.
This endpoint requires the incident_write
permission.
OAuth apps require the incident_write
authorization scope to access this endpoint.
이름
유형
설명
incident_id [required]
string
The UUID of the incident.
OK
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export incident_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents/${incident_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Delete an existing incident returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
# there is a valid "incident" in the system
INCIDENT_DATA_ID = environ["INCIDENT_DATA_ID"]
configuration = Configuration()
configuration.unstable_operations["delete_incident"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
api_instance.delete_incident(
incident_id=INCIDENT_DATA_ID,
)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Delete an existing incident returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.delete_incident".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
# there is a valid "incident" in the system
INCIDENT_DATA_ID = ENV["INCIDENT_DATA_ID"]
api_instance.delete_incident(INCIDENT_DATA_ID)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Delete an existing incident returns "OK" response
package main
import (
"context"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "incident" in the system
IncidentDataID := os.Getenv("INCIDENT_DATA_ID")
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.DeleteIncident", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewIncidentsApi(apiClient)
r, err := api.DeleteIncident(ctx, IncidentDataID)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IncidentsApi.DeleteIncident`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Delete an existing incident returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteIncident", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
// there is a valid "incident" in the system
String INCIDENT_DATA_ID = System.getenv("INCIDENT_DATA_ID");
try {
apiInstance.deleteIncident(INCIDENT_DATA_ID);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#deleteIncident");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// Delete an existing incident returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_incidents::IncidentsAPI;
#[tokio::main]
async fn main() {
// there is a valid "incident" in the system
let incident_data_id = std::env::var("INCIDENT_DATA_ID").unwrap();
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.DeleteIncident", true);
let api = IncidentsAPI::with_config(configuration);
let resp = api.delete_incident(incident_data_id.clone()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Delete an existing incident returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations["v2.deleteIncident"] = true;
const apiInstance = new v2.IncidentsApi(configuration);
// there is a valid "incident" in the system
const INCIDENT_DATA_ID = process.env.INCIDENT_DATA_ID as string;
const params: v2.IncidentsApiDeleteIncidentRequest = {
incidentId: INCIDENT_DATA_ID,
};
apiInstance
.deleteIncident(params)
.then((data: any) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
Note: This endpoint is in public beta. If you have any feedback, contact Datadog support.
GET https://api.ap1.datadoghq.com/api/v2/incidentshttps://api.datadoghq.eu/api/v2/incidentshttps://api.ddog-gov.com/api/v2/incidentshttps://api.datadoghq.com/api/v2/incidentshttps://api.us3.datadoghq.com/api/v2/incidentshttps://api.us5.datadoghq.com/api/v2/incidents
Get all incidents for the user’s organization.
This endpoint requires the incident_read
permission.
OAuth apps require the incident_read
authorization scope to access this endpoint.
이름
유형
설명
include
array
Specifies which types of related objects should be included in the response.
page[size]
integer
Size for a given page. The maximum allowed value is 100.
page[offset]
integer
Specific offset to use as the beginning of the returned page.