@@ -467,6 +467,24 @@ components:
467467 required: true
468468 schema:
469469 type: string
470+ IncidentImpactIDPathParameter:
471+ description: The UUID of the incident impact.
472+ in: path
473+ name: impact_id
474+ required: true
475+ schema:
476+ format: uuid
477+ type: string
478+ IncidentImpactIncludeQueryParameter:
479+ description: Specifies which related resources should be included in the response.
480+ explode: false
481+ in: query
482+ name: include
483+ required: false
484+ schema:
485+ items:
486+ $ref: '#/components/schemas/IncidentImpactRelatedObject'
487+ type: array
470488 IncidentIncludeQueryParameter:
471489 description: Specifies which types of related objects should be included in
472490 the response.
@@ -20120,6 +20138,177 @@ components:
2012020138 - TEXTARRAY
2012120139 - METRICTAG
2012220140 - AUTOCOMPLETE
20141+ IncidentImpactAttributes:
20142+ description: The incident impact's attributes.
20143+ properties:
20144+ created:
20145+ description: Timestamp when the impact was created.
20146+ example: '2025-08-29T13:17:00Z'
20147+ format: date-time
20148+ readOnly: true
20149+ type: string
20150+ description:
20151+ description: Description of the impact.
20152+ example: Service was unavailable for external users
20153+ type: string
20154+ end_at:
20155+ description: Timestamp when the impact ended.
20156+ example: '2025-08-29T13:17:00Z'
20157+ format: date-time
20158+ nullable: true
20159+ type: string
20160+ fields:
20161+ $ref: '#/components/schemas/IncidentImpactFieldsObject'
20162+ impact_type:
20163+ description: The type of impact.
20164+ example: customer
20165+ type: string
20166+ modified:
20167+ description: Timestamp when the impact was last modified.
20168+ example: '2025-08-29T13:17:00Z'
20169+ format: date-time
20170+ readOnly: true
20171+ type: string
20172+ start_at:
20173+ description: Timestamp representing when the impact started.
20174+ example: '2025-08-28T13:17:00Z'
20175+ format: date-time
20176+ type: string
20177+ required:
20178+ - description
20179+ - start_at
20180+ type: object
20181+ IncidentImpactCreateAttributes:
20182+ description: The incident impact's attributes for a create request.
20183+ properties:
20184+ description:
20185+ description: Description of the impact.
20186+ example: Service was unavailable for external users
20187+ type: string
20188+ end_at:
20189+ description: Timestamp when the impact ended.
20190+ example: '2025-08-29T13:17:00Z'
20191+ format: date-time
20192+ nullable: true
20193+ type: string
20194+ fields:
20195+ $ref: '#/components/schemas/IncidentImpactFieldsObject'
20196+ start_at:
20197+ description: Timestamp when the impact started.
20198+ example: '2025-08-28T13:17:00Z'
20199+ format: date-time
20200+ type: string
20201+ required:
20202+ - description
20203+ - start_at
20204+ type: object
20205+ IncidentImpactCreateData:
20206+ description: Incident impact data for a create request.
20207+ properties:
20208+ attributes:
20209+ $ref: '#/components/schemas/IncidentImpactCreateAttributes'
20210+ type:
20211+ $ref: '#/components/schemas/IncidentImpactType'
20212+ required:
20213+ - type
20214+ - attributes
20215+ type: object
20216+ IncidentImpactCreateRequest:
20217+ description: Create request for an incident impact.
20218+ properties:
20219+ data:
20220+ $ref: '#/components/schemas/IncidentImpactCreateData'
20221+ required:
20222+ - data
20223+ type: object
20224+ IncidentImpactFieldsObject:
20225+ additionalProperties: {}
20226+ description: An object mapping impact field names to field values.
20227+ example:
20228+ customers_impacted: all
20229+ products_impacted:
20230+ - shopping
20231+ - marketing
20232+ nullable: true
20233+ type: object
20234+ IncidentImpactRelatedObject:
20235+ description: A reference to a resource related to an incident impact.
20236+ enum:
20237+ - incident
20238+ - created_by_user
20239+ - last_modified_by_user
20240+ type: string
20241+ x-enum-varnames:
20242+ - INCIDENT
20243+ - CREATED_BY_USER
20244+ - LAST_MODIFIED_BY_USER
20245+ IncidentImpactRelationships:
20246+ description: The incident impact's resource relationships.
20247+ properties:
20248+ created_by_user:
20249+ $ref: '#/components/schemas/RelationshipToUser'
20250+ incident:
20251+ $ref: '#/components/schemas/RelationshipToIncident'
20252+ last_modified_by_user:
20253+ $ref: '#/components/schemas/RelationshipToUser'
20254+ type: object
20255+ IncidentImpactResponse:
20256+ description: Response with an incident impact.
20257+ properties:
20258+ data:
20259+ $ref: '#/components/schemas/IncidentImpactResponseData'
20260+ included:
20261+ description: Included related resources that the user requested.
20262+ items:
20263+ $ref: '#/components/schemas/IncidentUserData'
20264+ readOnly: true
20265+ type: array
20266+ required:
20267+ - data
20268+ type: object
20269+ IncidentImpactResponseData:
20270+ description: Incident impact data from a response.
20271+ properties:
20272+ attributes:
20273+ $ref: '#/components/schemas/IncidentImpactAttributes'
20274+ id:
20275+ description: The incident impact's ID.
20276+ example: 00000000-0000-0000-1234-000000000000
20277+ type: string
20278+ relationships:
20279+ $ref: '#/components/schemas/IncidentImpactRelationships'
20280+ type:
20281+ $ref: '#/components/schemas/IncidentImpactType'
20282+ required:
20283+ - id
20284+ - type
20285+ type: object
20286+ IncidentImpactType:
20287+ default: incident_impacts
20288+ description: Incident impact resource type.
20289+ enum:
20290+ - incident_impacts
20291+ example: incident_impacts
20292+ type: string
20293+ x-enum-varnames:
20294+ - INCIDENT_IMPACTS
20295+ IncidentImpactsResponse:
20296+ description: Response with a list of incident impacts.
20297+ properties:
20298+ data:
20299+ description: An array of incident impacts.
20300+ items:
20301+ $ref: '#/components/schemas/IncidentImpactResponseData'
20302+ type: array
20303+ included:
20304+ description: Included related resources that the user requested.
20305+ items:
20306+ $ref: '#/components/schemas/IncidentUserData'
20307+ readOnly: true
20308+ type: array
20309+ required:
20310+ - data
20311+ type: object
2012320312 IncidentImpactsType:
2012420313 description: The incident impacts type.
2012520314 enum:
@@ -20897,6 +21086,7 @@ components:
2089721086 - data
2089821087 type: object
2089921088 IncidentResponseAttributes:
21089+ additionalProperties: {}
2090021090 description: The incident's attributes from a response.
2090121091 properties:
2090221092 archived:
@@ -20941,6 +21131,17 @@ components:
2094121131 description: A flag indicating whether the incident caused customer impact.
2094221132 example: false
2094321133 type: boolean
21134+ declared:
21135+ description: Timestamp when the incident was declared.
21136+ format: date-time
21137+ readOnly: true
21138+ type: string
21139+ declared_by:
21140+ $ref: '#/components/schemas/IncidentNonDatadogCreator'
21141+ declared_by_uuid:
21142+ description: UUID of the user who declared the incident.
21143+ nullable: true
21144+ type: string
2094421145 detected:
2094521146 description: Timestamp when the incident was detected.
2094621147 format: date-time
@@ -21096,6 +21297,8 @@ components:
2109621297 $ref: '#/components/schemas/NullableRelationshipToUser'
2109721298 created_by_user:
2109821299 $ref: '#/components/schemas/RelationshipToUser'
21300+ declared_by_user:
21301+ $ref: '#/components/schemas/RelationshipToUser'
2109921302 impacts:
2110021303 $ref: '#/components/schemas/RelationshipToIncidentImpacts'
2110121304 integrations:
@@ -35408,6 +35611,14 @@ components:
3540835611 description: Relationship type.
3540935612 type: string
3541035613 type: object
35614+ RelationshipToIncident:
35615+ description: Relationship to incident.
35616+ properties:
35617+ data:
35618+ $ref: '#/components/schemas/RelationshipToIncidentData'
35619+ required:
35620+ - data
35621+ type: object
3541135622 RelationshipToIncidentAttachment:
3541235623 description: A relationship reference for attachments.
3541335624 properties:
@@ -35432,6 +35643,19 @@ components:
3543235643 - id
3543335644 - type
3543435645 type: object
35646+ RelationshipToIncidentData:
35647+ description: Relationship to incident object.
35648+ properties:
35649+ id:
35650+ description: A unique identifier that represents the incident.
35651+ example: 00000000-0000-0000-1234-000000000000
35652+ type: string
35653+ type:
35654+ $ref: '#/components/schemas/IncidentType'
35655+ required:
35656+ - id
35657+ - type
35658+ type: object
3543535659 RelationshipToIncidentImpactData:
3543635660 description: Relationship to impact object.
3543735661 properties:
@@ -56352,6 +56576,124 @@ paths:
5635256576 x-unstable: '**Note**: This endpoint is in public beta.
5635356577
5635456578 If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
56579+ /api/v2/incidents/{incident_id}/impacts:
56580+ get:
56581+ description: Get all impacts for an incident.
56582+ operationId: ListIncidentImpacts
56583+ parameters:
56584+ - $ref: '#/components/parameters/IncidentIDPathParameter'
56585+ - $ref: '#/components/parameters/IncidentImpactIncludeQueryParameter'
56586+ responses:
56587+ '200':
56588+ content:
56589+ application/json:
56590+ schema:
56591+ $ref: '#/components/schemas/IncidentImpactsResponse'
56592+ description: OK
56593+ '400':
56594+ $ref: '#/components/responses/BadRequestResponse'
56595+ '401':
56596+ $ref: '#/components/responses/UnauthorizedResponse'
56597+ '403':
56598+ $ref: '#/components/responses/ForbiddenResponse'
56599+ '404':
56600+ $ref: '#/components/responses/NotFoundResponse'
56601+ '429':
56602+ $ref: '#/components/responses/TooManyRequestsResponse'
56603+ security:
56604+ - apiKeyAuth: []
56605+ appKeyAuth: []
56606+ - AuthZ:
56607+ - incident_read
56608+ summary: List an incident's impacts
56609+ tags:
56610+ - Incidents
56611+ x-permission:
56612+ operator: OR
56613+ permissions:
56614+ - incident_read
56615+ x-unstable: '**Note**: This endpoint is in public beta.
56616+
56617+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
56618+ post:
56619+ description: Create an impact for an incident.
56620+ operationId: CreateIncidentImpact
56621+ parameters:
56622+ - $ref: '#/components/parameters/IncidentIDPathParameter'
56623+ - $ref: '#/components/parameters/IncidentImpactIncludeQueryParameter'
56624+ requestBody:
56625+ content:
56626+ application/json:
56627+ schema:
56628+ $ref: '#/components/schemas/IncidentImpactCreateRequest'
56629+ description: Incident impact payload.
56630+ required: true
56631+ responses:
56632+ '201':
56633+ content:
56634+ application/json:
56635+ schema:
56636+ $ref: '#/components/schemas/IncidentImpactResponse'
56637+ description: CREATED
56638+ '400':
56639+ $ref: '#/components/responses/BadRequestResponse'
56640+ '401':
56641+ $ref: '#/components/responses/UnauthorizedResponse'
56642+ '403':
56643+ $ref: '#/components/responses/ForbiddenResponse'
56644+ '404':
56645+ $ref: '#/components/responses/NotFoundResponse'
56646+ '429':
56647+ $ref: '#/components/responses/TooManyRequestsResponse'
56648+ security:
56649+ - apiKeyAuth: []
56650+ appKeyAuth: []
56651+ - AuthZ:
56652+ - incident_write
56653+ summary: Create an incident impact
56654+ tags:
56655+ - Incidents
56656+ x-codegen-request-body-name: body
56657+ x-permission:
56658+ operator: OR
56659+ permissions:
56660+ - incident_write
56661+ x-unstable: '**Note**: This endpoint is in public beta.
56662+
56663+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
56664+ /api/v2/incidents/{incident_id}/impacts/{impact_id}:
56665+ delete:
56666+ description: Delete an incident impact.
56667+ operationId: DeleteIncidentImpact
56668+ parameters:
56669+ - $ref: '#/components/parameters/IncidentIDPathParameter'
56670+ - $ref: '#/components/parameters/IncidentImpactIDPathParameter'
56671+ responses:
56672+ '204':
56673+ description: No Content
56674+ '401':
56675+ $ref: '#/components/responses/UnauthorizedResponse'
56676+ '403':
56677+ $ref: '#/components/responses/ForbiddenResponse'
56678+ '404':
56679+ $ref: '#/components/responses/NotFoundResponse'
56680+ '429':
56681+ $ref: '#/components/responses/TooManyRequestsResponse'
56682+ security:
56683+ - apiKeyAuth: []
56684+ appKeyAuth: []
56685+ - AuthZ:
56686+ - incident_write
56687+ summary: Delete an incident impact
56688+ tags:
56689+ - Incidents
56690+ x-permission:
56691+ operator: OR
56692+ permissions:
56693+ - incident_write
56694+ x-unstable: '**Note**: This endpoint is in public beta.
56695+
56696+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
5635556697 /api/v2/incidents/{incident_id}/relationships/integrations:
5635656698 get:
5635756699 description: Get all integration metadata for an incident.
0 commit comments