--- title: Send an incident event description: Use this API endpoint to provide incident data for DORA Metrics. breadcrumbs: ドキュメント > API > Send an incident event --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # Send an incident event ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------ | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/dora/failure | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/dora/failure | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/dora/failure | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/dora/failure | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/dora/failure | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/dora/failure | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/dora/failure | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/dora/failure | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/dora/failure | ### Overview Use this API endpoint to provide incident data for DORA Metrics. Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint. Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency. ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | The JSON:API data. | | data | attributes [*required*] | object | Attributes to create a DORA incident event. | | attributes | custom_tags | [string] | A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event. | | attributes | env | string | Environment name that was impacted by the incident. | | attributes | finished_at | int64 | Unix timestamp when the incident finished. It must be in nanoseconds, milliseconds, or seconds. | | attributes | git | object | Git info for DORA Metrics events. | | git | commit_sha [*required*] | string | Git Commit SHA. | | git | repository_url [*required*] | string | Git Repository URL | | attributes | id | string | Incident ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :). | | attributes | name | string | Incident name. | | attributes | services | [string] | Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided. | | attributes | severity | string | Incident severity. | | attributes | started_at [*required*] | int64 | Unix timestamp when the incident started. It must be in nanoseconds, milliseconds, or seconds. | | attributes | team | string | Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided. | | attributes | version | string | Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking.md). | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "custom_tags": [ "language:java", "department:engineering" ], "env": "staging", "finished_at": 1693491984000000000, "git": { "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository" }, "id": "string", "name": "Webserver is down failing all requests.", "services": [ "shopist" ], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07" } } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response after receiving a DORA incident event. | Parent field | Field | Type | Description | | ------------ | ----------------- | ------ | ----------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Response after receiving a DORA incident event. | | data | id [*required*] | string | The ID of the received DORA incident event. | | data | type | enum | JSON:API type for DORA incident events. Allowed enum values: `dora_failure`. Default: `dora_failure`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "id": "4242fcdd31586083", "type": "dora_failure" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="202" %} OK - but delayed due to incident {% tabs %} {% tab label="Model" %} Response after receiving a DORA incident event. | Parent field | Field | Type | Description | | ------------ | ----------------- | ------ | ----------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Response after receiving a DORA incident event. | | data | id [*required*] | string | The ID of the received DORA incident event. | | data | type | enum | JSON:API type for DORA incident events. Allowed enum values: `dora_failure`. Default: `dora_failure`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "id": "4242fcdd31586083", "type": "dora_failure" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Not Authorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com export DD_API_KEY="" curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -d @- << EOF { "data": { "attributes": { "custom_tags": [ "language:java", "department:engineering" ], "env": "staging", "finished_at": 1693491984000000000, "git": { "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository" }, "name": "Webserver is down failing all requests.", "services": [ "test-service" ], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07" } } } EOF ``` {% /tab %} {% /tabs %}