Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
341 changes: 341 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,23 @@ components:
required: true
schema:
type: string
IncidentImpactIDPathParameter:
description: The UUID of the incident impact.
in: path
name: impact_id
required: true
schema:
type: string
IncidentImpactIncludeQueryParameter:
description: Specifies which related resources should be included in the response.
explode: false
in: query
name: include
required: false
schema:
items:
$ref: '#/components/schemas/IncidentImpactRelatedObject'
type: array
IncidentIncludeQueryParameter:
description: Specifies which types of related objects should be included in
the response.
Expand Down Expand Up @@ -20120,6 +20137,177 @@ components:
- TEXTARRAY
- METRICTAG
- AUTOCOMPLETE
IncidentImpactAttributes:
description: The incident impact's attributes.
properties:
created:
description: Timestamp when the impact was created.
example: '2025-08-29T13:17:00Z'
format: date-time
readOnly: true
type: string
description:
description: Description of the impact.
example: Service was unavailable for external users
type: string
end_at:
description: Timestamp when the impact ended.
example: '2025-08-29T13:17:00Z'
format: date-time
nullable: true
type: string
fields:
$ref: '#/components/schemas/IncidentImpactFieldsObject'
impact_type:
description: The type of impact.
example: customer
type: string
modified:
description: Timestamp when the impact was last modified.
example: '2025-08-29T13:17:00Z'
format: date-time
readOnly: true
type: string
start_at:
description: Timestamp representing when the impact started.
example: '2025-08-28T13:17:00Z'
format: date-time
type: string
required:
- description
- start_at
type: object
IncidentImpactCreateAttributes:
description: The incident impact's attributes for a create request.
properties:
description:
description: Description of the impact.
example: Service was unavailable for external users
type: string
end_at:
description: Timestamp when the impact ended.
example: '2025-08-29T13:17:00Z'
format: date-time
nullable: true
type: string
fields:
$ref: '#/components/schemas/IncidentImpactFieldsObject'
start_at:
description: Timestamp when the impact started.
example: '2025-08-28T13:17:00Z'
format: date-time
type: string
required:
- description
- start_at
type: object
IncidentImpactCreateData:
description: Incident impact data for a create request.
properties:
attributes:
$ref: '#/components/schemas/IncidentImpactCreateAttributes'
type:
$ref: '#/components/schemas/IncidentImpactType'
required:
- type
- attributes
type: object
IncidentImpactCreateRequest:
description: Create request for an incident impact.
properties:
data:
$ref: '#/components/schemas/IncidentImpactCreateData'
required:
- data
type: object
IncidentImpactFieldsObject:
additionalProperties: {}
description: An object mapping impact field names to field values.
example:
customers_impacted: all
products_impacted:
- shopping
- marketing
nullable: true
type: object
IncidentImpactRelatedObject:
description: A reference to a resource related to an incident impact.
enum:
- incident
- created_by_user
- last_modified_by_user
type: string
x-enum-varnames:
- INCIDENT
- CREATED_BY_USER
- LAST_MODIFIED_BY_USER
IncidentImpactRelationships:
description: The incident impact's resource relationships.
properties:
created_by_user:
$ref: '#/components/schemas/RelationshipToUser'
incident:
$ref: '#/components/schemas/RelationshipToIncident'
last_modified_by_user:
$ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentImpactResponse:
description: Response with an incident impact.
properties:
data:
$ref: '#/components/schemas/IncidentImpactResponseData'
included:
description: Included related resources that the user requested.
items:
$ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
- data
type: object
IncidentImpactResponseData:
description: Incident impact data from a response.
properties:
attributes:
$ref: '#/components/schemas/IncidentImpactAttributes'
id:
description: The incident impact's ID.
example: 00000000-0000-0000-1234-000000000000
type: string
relationships:
$ref: '#/components/schemas/IncidentImpactRelationships'
type:
$ref: '#/components/schemas/IncidentImpactType'
required:
- id
- type
type: object
IncidentImpactType:
default: incident_impacts
description: Incident impact resource type.
enum:
- incident_impacts
example: incident_impacts
type: string
x-enum-varnames:
- INCIDENT_IMPACTS
IncidentImpactsResponse:
description: Response with a list of incident impacts.
properties:
data:
description: An array of incident impacts.
items:
$ref: '#/components/schemas/IncidentImpactResponseData'
type: array
included:
description: Included related resources that the user requested.
items:
$ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
- data
type: object
IncidentImpactsType:
description: The incident impacts type.
enum:
Expand Down Expand Up @@ -20897,6 +21085,7 @@ components:
- data
type: object
IncidentResponseAttributes:
additionalProperties: {}
description: The incident's attributes from a response.
properties:
archived:
Expand Down Expand Up @@ -20941,6 +21130,17 @@ components:
description: A flag indicating whether the incident caused customer impact.
example: false
type: boolean
declared:
description: Timestamp when the incident was declared.
format: date-time
readOnly: true
type: string
declared_by:
$ref: '#/components/schemas/IncidentNonDatadogCreator'
declared_by_uuid:
description: UUID of the user who declared the incident.
nullable: true
type: string
detected:
description: Timestamp when the incident was detected.
format: date-time
Expand Down Expand Up @@ -21096,6 +21296,8 @@ components:
$ref: '#/components/schemas/NullableRelationshipToUser'
created_by_user:
$ref: '#/components/schemas/RelationshipToUser'
declared_by_user:
$ref: '#/components/schemas/RelationshipToUser'
impacts:
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
integrations:
Expand Down Expand Up @@ -35408,6 +35610,14 @@ components:
description: Relationship type.
type: string
type: object
RelationshipToIncident:
description: Relationship to incident.
properties:
data:
$ref: '#/components/schemas/RelationshipToIncidentData'
required:
- data
type: object
RelationshipToIncidentAttachment:
description: A relationship reference for attachments.
properties:
Expand All @@ -35432,6 +35642,19 @@ components:
- id
- type
type: object
RelationshipToIncidentData:
description: Relationship to incident object.
properties:
id:
description: A unique identifier that represents the incident.
example: 00000000-0000-0000-1234-000000000000
type: string
type:
$ref: '#/components/schemas/IncidentType'
required:
- id
- type
type: object
RelationshipToIncidentImpactData:
description: Relationship to impact object.
properties:
Expand Down Expand Up @@ -56351,6 +56574,124 @@ paths:
- incident_write
x-unstable: '**Note**: This endpoint is in public beta.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}/impacts:
get:
description: Get all impacts for an incident.
operationId: ListIncidentImpacts
parameters:
- $ref: '#/components/parameters/IncidentIDPathParameter'
- $ref: '#/components/parameters/IncidentImpactIncludeQueryParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentImpactsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_read
summary: List an incident's impacts
tags:
- Incidents
x-permission:
operator: OR
permissions:
- incident_read
x-unstable: '**Note**: This endpoint is in Preview.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
post:
description: Create an impact for an incident.
operationId: CreateIncidentImpact
parameters:
- $ref: '#/components/parameters/IncidentIDPathParameter'
- $ref: '#/components/parameters/IncidentImpactIncludeQueryParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentImpactCreateRequest'
description: Incident impact payload.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentImpactResponse'
description: CREATED
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_write
summary: Create an incident impact
tags:
- Incidents
x-codegen-request-body-name: body
x-permission:
operator: OR
permissions:
- incident_write
x-unstable: '**Note**: This endpoint is in Preview.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}/impacts/{impact_id}:
delete:
description: Delete an incident impact.
operationId: DeleteIncidentImpact
parameters:
- $ref: '#/components/parameters/IncidentIDPathParameter'
- $ref: '#/components/parameters/IncidentImpactIDPathParameter'
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_write
summary: Delete an incident impact
tags:
- Incidents
x-permission:
operator: OR
permissions:
- incident_write
x-unstable: '**Note**: This endpoint is in Preview.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/incidents/{incident_id}/relationships/integrations:
get:
Expand Down
Loading