Skip to content

Commit cb19bee

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 33fc2bd of spec repo
1 parent 5a8db46 commit cb19bee

File tree

94 files changed

+2016
-377
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+2016
-377
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 378 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,17 @@ components:
562562
items:
563563
$ref: '#/components/schemas/IncidentImpactRelatedObject'
564564
type: array
565+
IncidentImportIncludeQueryParameter:
566+
description: Specifies which related object types to include in the response
567+
when importing an incident.
568+
explode: false
569+
in: query
570+
name: include
571+
required: false
572+
schema:
573+
items:
574+
$ref: '#/components/schemas/IncidentImportRelatedObject'
575+
type: array
565576
IncidentIncludeQueryParameter:
566577
description: Specifies which types of related objects should be included in
567578
the response.
@@ -30076,6 +30087,321 @@ components:
3007630087
type: string
3007730088
x-enum-varnames:
3007830089
- INCIDENT_IMPACTS
30090+
IncidentImportFieldAttributes:
30091+
description: Dynamic fields for which selections can be made, with field names
30092+
as keys.
30093+
oneOf:
30094+
- $ref: '#/components/schemas/IncidentImportFieldAttributesSingleValue'
30095+
- $ref: '#/components/schemas/IncidentImportFieldAttributesMultipleValue'
30096+
IncidentImportFieldAttributesMultipleValue:
30097+
additionalProperties: false
30098+
description: A field with potentially multiple values selected.
30099+
properties:
30100+
value:
30101+
description: The multiple values selected for this field.
30102+
example:
30103+
- '1.0'
30104+
- '1.1'
30105+
items:
30106+
description: A value which has been selected for the parent field.
30107+
example: '1.1'
30108+
type: string
30109+
nullable: true
30110+
type: array
30111+
type: object
30112+
IncidentImportFieldAttributesSingleValue:
30113+
additionalProperties: false
30114+
description: A field with a single value selected.
30115+
properties:
30116+
value:
30117+
description: The single value selected for this field.
30118+
example: SEV-1
30119+
nullable: true
30120+
type: string
30121+
type: object
30122+
IncidentImportRelatedObject:
30123+
description: Object related to an incident that can be included in the response.
30124+
enum:
30125+
- last_modified_by_user
30126+
- created_by_user
30127+
- commander_user
30128+
- declared_by_user
30129+
- incident_type
30130+
type: string
30131+
x-enum-varnames:
30132+
- LAST_MODIFIED_BY_USER
30133+
- CREATED_BY_USER
30134+
- COMMANDER_USER
30135+
- DECLARED_BY_USER
30136+
- INCIDENT_TYPE
30137+
IncidentImportRelationships:
30138+
description: The relationships for an incident import request.
30139+
properties:
30140+
commander_user:
30141+
$ref: '#/components/schemas/NullableRelationshipToUser'
30142+
declared_by_user:
30143+
$ref: '#/components/schemas/NullableRelationshipToUser'
30144+
type: object
30145+
IncidentImportRequest:
30146+
description: Import request for an incident. Used to import historical incidents
30147+
from external systems.
30148+
properties:
30149+
data:
30150+
$ref: '#/components/schemas/IncidentImportRequestData'
30151+
required:
30152+
- data
30153+
type: object
30154+
IncidentImportRequestAttributes:
30155+
description: The incident's attributes for an import request.
30156+
properties:
30157+
declared:
30158+
description: Timestamp when the incident was declared.
30159+
example: '2025-01-01T00:00:00Z'
30160+
format: date-time
30161+
type: string
30162+
detected:
30163+
description: Timestamp when the incident was detected.
30164+
example: '2025-01-01T00:00:00Z'
30165+
format: date-time
30166+
type: string
30167+
fields:
30168+
additionalProperties:
30169+
$ref: '#/components/schemas/IncidentImportFieldAttributes'
30170+
description: A condensed view of the user-defined fields for which to create
30171+
initial selections.
30172+
example:
30173+
severity:
30174+
value: SEV-5
30175+
state:
30176+
value: active
30177+
type: object
30178+
incident_type_uuid:
30179+
description: A unique identifier that represents the incident type. If not
30180+
provided, the default incident type is used.
30181+
example: 00000000-0000-0000-0000-000000000000
30182+
type: string
30183+
resolved:
30184+
description: Timestamp when the incident was resolved. Can only be set when
30185+
the state field is set to 'resolved'.
30186+
example: '2025-01-01T01:00:00Z'
30187+
format: date-time
30188+
type: string
30189+
title:
30190+
description: The title of the incident that summarizes what happened.
30191+
example: Imported incident from external system
30192+
maxLength: 1024
30193+
type: string
30194+
visibility:
30195+
$ref: '#/components/schemas/IncidentImportVisibility'
30196+
required:
30197+
- title
30198+
type: object
30199+
IncidentImportRequestData:
30200+
description: Incident data for an import request.
30201+
properties:
30202+
attributes:
30203+
$ref: '#/components/schemas/IncidentImportRequestAttributes'
30204+
relationships:
30205+
$ref: '#/components/schemas/IncidentImportRelationships'
30206+
type:
30207+
$ref: '#/components/schemas/IncidentType'
30208+
required:
30209+
- type
30210+
- attributes
30211+
type: object
30212+
IncidentImportResponse:
30213+
description: Response with an incident.
30214+
properties:
30215+
data:
30216+
$ref: '#/components/schemas/IncidentImportResponseData'
30217+
included:
30218+
description: Included related resources that the user requested.
30219+
items:
30220+
$ref: '#/components/schemas/IncidentImportResponseIncludedItem'
30221+
readOnly: true
30222+
type: array
30223+
required:
30224+
- data
30225+
type: object
30226+
IncidentImportResponseAttributes:
30227+
description: The incident's attributes from an import response.
30228+
properties:
30229+
archived:
30230+
description: Timestamp when the incident was archived.
30231+
format: date-time
30232+
nullable: true
30233+
readOnly: true
30234+
type: string
30235+
case_id:
30236+
description: The incident case ID.
30237+
format: int64
30238+
nullable: true
30239+
type: integer
30240+
created:
30241+
description: Timestamp when the incident was created.
30242+
example: '2025-01-01T00:00:00Z'
30243+
format: date-time
30244+
readOnly: true
30245+
type: string
30246+
created_by_uuid:
30247+
description: UUID of the user who created the incident.
30248+
nullable: true
30249+
type: string
30250+
creation_idempotency_key:
30251+
description: A unique key used to ensure idempotent incident creation.
30252+
nullable: true
30253+
type: string
30254+
customer_impact_end:
30255+
description: Timestamp when customers were no longer impacted by the incident.
30256+
format: date-time
30257+
nullable: true
30258+
type: string
30259+
customer_impact_scope:
30260+
description: A summary of the impact customers experienced during the incident.
30261+
example: An example customer impact scope
30262+
nullable: true
30263+
type: string
30264+
customer_impact_start:
30265+
description: Timestamp when customers began to be impacted by the incident.
30266+
format: date-time
30267+
nullable: true
30268+
type: string
30269+
declared:
30270+
description: Timestamp when the incident was declared.
30271+
example: '2025-01-01T00:00:00Z'
30272+
format: date-time
30273+
nullable: true
30274+
type: string
30275+
declared_by_uuid:
30276+
description: UUID of the user who declared the incident.
30277+
nullable: true
30278+
type: string
30279+
detected:
30280+
description: Timestamp when the incident was detected.
30281+
example: '2025-01-01T00:00:00Z'
30282+
format: date-time
30283+
nullable: true
30284+
type: string
30285+
fields:
30286+
additionalProperties:
30287+
$ref: '#/components/schemas/IncidentFieldAttributes'
30288+
description: A condensed view of the user-defined fields attached to incidents.
30289+
example:
30290+
severity:
30291+
type: dropdown
30292+
value: SEV-5
30293+
type: object
30294+
incident_type_uuid:
30295+
description: A unique identifier that represents an incident type.
30296+
example: 00000000-0000-0000-0000-000000000000
30297+
type: string
30298+
is_test:
30299+
description: A flag indicating whether the incident is a test incident.
30300+
example: false
30301+
type: boolean
30302+
last_modified_by_uuid:
30303+
description: UUID of the user who last modified the incident.
30304+
nullable: true
30305+
type: string
30306+
modified:
30307+
description: Timestamp when the incident was last modified.
30308+
format: date-time
30309+
readOnly: true
30310+
type: string
30311+
non_datadog_creator:
30312+
$ref: '#/components/schemas/IncidentNonDatadogCreator'
30313+
notification_handles:
30314+
description: Notification handles that are notified of the incident during
30315+
update.
30316+
items:
30317+
$ref: '#/components/schemas/IncidentNotificationHandle'
30318+
nullable: true
30319+
type: array
30320+
public_id:
30321+
description: The monotonically increasing integer ID for the incident.
30322+
example: 1
30323+
format: int64
30324+
type: integer
30325+
resolved:
30326+
description: Timestamp when the incident's state was last changed from active
30327+
or stable to resolved or completed.
30328+
format: date-time
30329+
nullable: true
30330+
type: string
30331+
severity:
30332+
$ref: '#/components/schemas/IncidentSeverity'
30333+
state:
30334+
description: The state of the incident.
30335+
nullable: true
30336+
type: string
30337+
title:
30338+
description: The title of the incident that summarizes what happened.
30339+
example: A test incident title
30340+
type: string
30341+
visibility:
30342+
description: The incident visibility status.
30343+
nullable: true
30344+
type: string
30345+
required:
30346+
- title
30347+
type: object
30348+
IncidentImportResponseData:
30349+
description: Incident data from an import response.
30350+
properties:
30351+
attributes:
30352+
$ref: '#/components/schemas/IncidentImportResponseAttributes'
30353+
id:
30354+
description: The incident's ID.
30355+
example: 00000000-0000-0000-1234-000000000000
30356+
type: string
30357+
relationships:
30358+
$ref: '#/components/schemas/IncidentImportResponseRelationships'
30359+
type:
30360+
$ref: '#/components/schemas/IncidentType'
30361+
required:
30362+
- id
30363+
- type
30364+
type: object
30365+
IncidentImportResponseIncludedItem:
30366+
description: An object related to an incident that is included in the response.
30367+
oneOf:
30368+
- $ref: '#/components/schemas/IncidentUserData'
30369+
- $ref: '#/components/schemas/IncidentTypeObject'
30370+
IncidentImportResponseRelationships:
30371+
description: The incident's relationships from an import response.
30372+
properties:
30373+
attachments:
30374+
$ref: '#/components/schemas/RelationshipToIncidentAttachment'
30375+
commander_user:
30376+
$ref: '#/components/schemas/NullableRelationshipToUser'
30377+
created_by_user:
30378+
$ref: '#/components/schemas/RelationshipToUser'
30379+
declared_by_user:
30380+
$ref: '#/components/schemas/RelationshipToUser'
30381+
impacts:
30382+
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
30383+
incident_type:
30384+
$ref: '#/components/schemas/RelationshipToIncidentType'
30385+
integrations:
30386+
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
30387+
last_modified_by_user:
30388+
$ref: '#/components/schemas/RelationshipToUser'
30389+
responders:
30390+
$ref: '#/components/schemas/RelationshipToIncidentResponders'
30391+
user_defined_fields:
30392+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
30393+
type: object
30394+
IncidentImportVisibility:
30395+
default: organization
30396+
description: The visibility of the incident.
30397+
enum:
30398+
- organization
30399+
- private
30400+
example: organization
30401+
type: string
30402+
x-enum-varnames:
30403+
- ORGANIZATION
30404+
- PRIVATE
3007930405
IncidentIntegrationMetadataAttributes:
3008030406
description: Incident integration metadata's attributes for a create request.
3008130407
properties:
@@ -82264,6 +82590,58 @@ paths:
8226482590
- incident_settings_write
8226582591
x-unstable: '**Note**: This endpoint is in public beta.
8226682592

82593+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
82594+
/api/v2/incidents/import:
82595+
post:
82596+
description: 'Import an incident from an external system. This endpoint allows
82597+
you to create incidents with
82598+
82599+
historical data such as custom timestamps for detection, declaration, and
82600+
resolution.
82601+
82602+
Imported incidents do not execute integrations or notification rules.'
82603+
operationId: ImportIncident
82604+
parameters:
82605+
- $ref: '#/components/parameters/IncidentImportIncludeQueryParameter'
82606+
requestBody:
82607+
content:
82608+
application/json:
82609+
schema:
82610+
$ref: '#/components/schemas/IncidentImportRequest'
82611+
description: Incident import payload.
82612+
required: true
82613+
responses:
82614+
'201':
82615+
content:
82616+
application/json:
82617+
schema:
82618+
$ref: '#/components/schemas/IncidentImportResponse'
82619+
description: CREATED
82620+
'400':
82621+
$ref: '#/components/responses/BadRequestResponse'
82622+
'401':
82623+
$ref: '#/components/responses/UnauthorizedResponse'
82624+
'403':
82625+
$ref: '#/components/responses/ForbiddenResponse'
82626+
'404':
82627+
$ref: '#/components/responses/NotFoundResponse'
82628+
'429':
82629+
$ref: '#/components/responses/TooManyRequestsResponse'
82630+
security:
82631+
- apiKeyAuth: []
82632+
appKeyAuth: []
82633+
- AuthZ:
82634+
- incident_write
82635+
summary: Import an incident
82636+
tags:
82637+
- Incidents
82638+
x-codegen-request-body-name: body
82639+
x-permission:
82640+
operator: AND
82641+
permissions:
82642+
- incident_write
82643+
x-unstable: '**Note**: This endpoint is in Preview.
82644+
8226782645
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8226882646
/api/v2/incidents/search:
8226982647
get:

0 commit comments

Comments
 (0)