@@ -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.
@@ -30071,6 +30082,321 @@ components:
3007130082 type: string
3007230083 x-enum-varnames:
3007330084 - INCIDENT_IMPACTS
30085+ IncidentImportFieldAttributes:
30086+ description: Dynamic fields for which selections can be made, with field names
30087+ as keys.
30088+ oneOf:
30089+ - $ref: '#/components/schemas/IncidentImportFieldAttributesSingleValue'
30090+ - $ref: '#/components/schemas/IncidentImportFieldAttributesMultipleValue'
30091+ IncidentImportFieldAttributesMultipleValue:
30092+ additionalProperties: false
30093+ description: A field with potentially multiple values selected.
30094+ properties:
30095+ value:
30096+ description: The multiple values selected for this field.
30097+ example:
30098+ - '1.0'
30099+ - '1.1'
30100+ items:
30101+ description: A value which has been selected for the parent field.
30102+ example: '1.1'
30103+ type: string
30104+ nullable: true
30105+ type: array
30106+ type: object
30107+ IncidentImportFieldAttributesSingleValue:
30108+ additionalProperties: false
30109+ description: A field with a single value selected.
30110+ properties:
30111+ value:
30112+ description: The single value selected for this field.
30113+ example: SEV-1
30114+ nullable: true
30115+ type: string
30116+ type: object
30117+ IncidentImportRelatedObject:
30118+ description: Object related to an incident that can be included in the response.
30119+ enum:
30120+ - last_modified_by_user
30121+ - created_by_user
30122+ - commander_user
30123+ - declared_by_user
30124+ - incident_type
30125+ type: string
30126+ x-enum-varnames:
30127+ - LAST_MODIFIED_BY_USER
30128+ - CREATED_BY_USER
30129+ - COMMANDER_USER
30130+ - DECLARED_BY_USER
30131+ - INCIDENT_TYPE
30132+ IncidentImportRelationships:
30133+ description: The relationships for an incident import request.
30134+ properties:
30135+ commander_user:
30136+ $ref: '#/components/schemas/NullableRelationshipToUser'
30137+ declared_by_user:
30138+ $ref: '#/components/schemas/NullableRelationshipToUser'
30139+ type: object
30140+ IncidentImportRequest:
30141+ description: Import request for an incident. Used to import historical incidents
30142+ from external systems.
30143+ properties:
30144+ data:
30145+ $ref: '#/components/schemas/IncidentImportRequestData'
30146+ required:
30147+ - data
30148+ type: object
30149+ IncidentImportRequestAttributes:
30150+ description: The incident's attributes for an import request.
30151+ properties:
30152+ declared:
30153+ description: Timestamp when the incident was declared.
30154+ example: '2025-01-01T00:00:00Z'
30155+ format: date-time
30156+ type: string
30157+ detected:
30158+ description: Timestamp when the incident was detected.
30159+ example: '2025-01-01T00:00:00Z'
30160+ format: date-time
30161+ type: string
30162+ fields:
30163+ additionalProperties:
30164+ $ref: '#/components/schemas/IncidentImportFieldAttributes'
30165+ description: A condensed view of the user-defined fields for which to create
30166+ initial selections.
30167+ example:
30168+ severity:
30169+ value: SEV-5
30170+ state:
30171+ value: active
30172+ type: object
30173+ incident_type_uuid:
30174+ description: A unique identifier that represents the incident type. If not
30175+ provided, the default incident type is used.
30176+ example: 00000000-0000-0000-0000-000000000000
30177+ type: string
30178+ resolved:
30179+ description: Timestamp when the incident was resolved. Can only be set when
30180+ the state field is set to 'resolved'.
30181+ example: '2025-01-01T01:00:00Z'
30182+ format: date-time
30183+ type: string
30184+ title:
30185+ description: The title of the incident that summarizes what happened.
30186+ example: Imported incident from external system
30187+ maxLength: 1024
30188+ type: string
30189+ visibility:
30190+ $ref: '#/components/schemas/IncidentImportVisibility'
30191+ required:
30192+ - title
30193+ type: object
30194+ IncidentImportRequestData:
30195+ description: Incident data for an import request.
30196+ properties:
30197+ attributes:
30198+ $ref: '#/components/schemas/IncidentImportRequestAttributes'
30199+ relationships:
30200+ $ref: '#/components/schemas/IncidentImportRelationships'
30201+ type:
30202+ $ref: '#/components/schemas/IncidentType'
30203+ required:
30204+ - type
30205+ - attributes
30206+ type: object
30207+ IncidentImportResponse:
30208+ description: Response with an incident.
30209+ properties:
30210+ data:
30211+ $ref: '#/components/schemas/IncidentImportResponseData'
30212+ included:
30213+ description: Included related resources that the user requested.
30214+ items:
30215+ $ref: '#/components/schemas/IncidentImportResponseIncludedItem'
30216+ readOnly: true
30217+ type: array
30218+ required:
30219+ - data
30220+ type: object
30221+ IncidentImportResponseAttributes:
30222+ description: The incident's attributes from an import response.
30223+ properties:
30224+ archived:
30225+ description: Timestamp when the incident was archived.
30226+ format: date-time
30227+ nullable: true
30228+ readOnly: true
30229+ type: string
30230+ case_id:
30231+ description: The incident case ID.
30232+ format: int64
30233+ nullable: true
30234+ type: integer
30235+ created:
30236+ description: Timestamp when the incident was created.
30237+ example: '2025-01-01T00:00:00Z'
30238+ format: date-time
30239+ readOnly: true
30240+ type: string
30241+ created_by_uuid:
30242+ description: UUID of the user who created the incident.
30243+ nullable: true
30244+ type: string
30245+ creation_idempotency_key:
30246+ description: A unique key used to ensure idempotent incident creation.
30247+ nullable: true
30248+ type: string
30249+ customer_impact_end:
30250+ description: Timestamp when customers were no longer impacted by the incident.
30251+ format: date-time
30252+ nullable: true
30253+ type: string
30254+ customer_impact_scope:
30255+ description: A summary of the impact customers experienced during the incident.
30256+ example: An example customer impact scope
30257+ nullable: true
30258+ type: string
30259+ customer_impact_start:
30260+ description: Timestamp when customers began to be impacted by the incident.
30261+ format: date-time
30262+ nullable: true
30263+ type: string
30264+ declared:
30265+ description: Timestamp when the incident was declared.
30266+ example: '2025-01-01T00:00:00Z'
30267+ format: date-time
30268+ nullable: true
30269+ type: string
30270+ declared_by_uuid:
30271+ description: UUID of the user who declared the incident.
30272+ nullable: true
30273+ type: string
30274+ detected:
30275+ description: Timestamp when the incident was detected.
30276+ example: '2025-01-01T00:00:00Z'
30277+ format: date-time
30278+ nullable: true
30279+ type: string
30280+ fields:
30281+ additionalProperties:
30282+ $ref: '#/components/schemas/IncidentFieldAttributes'
30283+ description: A condensed view of the user-defined fields attached to incidents.
30284+ example:
30285+ severity:
30286+ type: dropdown
30287+ value: SEV-5
30288+ type: object
30289+ incident_type_uuid:
30290+ description: A unique identifier that represents an incident type.
30291+ example: 00000000-0000-0000-0000-000000000000
30292+ type: string
30293+ is_test:
30294+ description: A flag indicating whether the incident is a test incident.
30295+ example: false
30296+ type: boolean
30297+ last_modified_by_uuid:
30298+ description: UUID of the user who last modified the incident.
30299+ nullable: true
30300+ type: string
30301+ modified:
30302+ description: Timestamp when the incident was last modified.
30303+ format: date-time
30304+ readOnly: true
30305+ type: string
30306+ non_datadog_creator:
30307+ $ref: '#/components/schemas/IncidentNonDatadogCreator'
30308+ notification_handles:
30309+ description: Notification handles that are notified of the incident during
30310+ update.
30311+ items:
30312+ $ref: '#/components/schemas/IncidentNotificationHandle'
30313+ nullable: true
30314+ type: array
30315+ public_id:
30316+ description: The monotonically increasing integer ID for the incident.
30317+ example: 1
30318+ format: int64
30319+ type: integer
30320+ resolved:
30321+ description: Timestamp when the incident's state was last changed from active
30322+ or stable to resolved or completed.
30323+ format: date-time
30324+ nullable: true
30325+ type: string
30326+ severity:
30327+ $ref: '#/components/schemas/IncidentSeverity'
30328+ state:
30329+ description: The state of the incident.
30330+ nullable: true
30331+ type: string
30332+ title:
30333+ description: The title of the incident that summarizes what happened.
30334+ example: A test incident title
30335+ type: string
30336+ visibility:
30337+ description: The incident visibility status.
30338+ nullable: true
30339+ type: string
30340+ required:
30341+ - title
30342+ type: object
30343+ IncidentImportResponseData:
30344+ description: Incident data from an import response.
30345+ properties:
30346+ attributes:
30347+ $ref: '#/components/schemas/IncidentImportResponseAttributes'
30348+ id:
30349+ description: The incident's ID.
30350+ example: 00000000-0000-0000-1234-000000000000
30351+ type: string
30352+ relationships:
30353+ $ref: '#/components/schemas/IncidentImportResponseRelationships'
30354+ type:
30355+ $ref: '#/components/schemas/IncidentType'
30356+ required:
30357+ - id
30358+ - type
30359+ type: object
30360+ IncidentImportResponseIncludedItem:
30361+ description: An object related to an incident that is included in the response.
30362+ oneOf:
30363+ - $ref: '#/components/schemas/IncidentUserData'
30364+ - $ref: '#/components/schemas/IncidentTypeObject'
30365+ IncidentImportResponseRelationships:
30366+ description: The incident's relationships from an import response.
30367+ properties:
30368+ attachments:
30369+ $ref: '#/components/schemas/RelationshipToIncidentAttachment'
30370+ commander_user:
30371+ $ref: '#/components/schemas/NullableRelationshipToUser'
30372+ created_by_user:
30373+ $ref: '#/components/schemas/RelationshipToUser'
30374+ declared_by_user:
30375+ $ref: '#/components/schemas/RelationshipToUser'
30376+ impacts:
30377+ $ref: '#/components/schemas/RelationshipToIncidentImpacts'
30378+ incident_type:
30379+ $ref: '#/components/schemas/RelationshipToIncidentType'
30380+ integrations:
30381+ $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
30382+ last_modified_by_user:
30383+ $ref: '#/components/schemas/RelationshipToUser'
30384+ responders:
30385+ $ref: '#/components/schemas/RelationshipToIncidentResponders'
30386+ user_defined_fields:
30387+ $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
30388+ type: object
30389+ IncidentImportVisibility:
30390+ default: organization
30391+ description: The visibility of the incident.
30392+ enum:
30393+ - organization
30394+ - private
30395+ example: organization
30396+ type: string
30397+ x-enum-varnames:
30398+ - ORGANIZATION
30399+ - PRIVATE
3007430400 IncidentIntegrationMetadataAttributes:
3007530401 description: Incident integration metadata's attributes for a create request.
3007630402 properties:
@@ -81988,6 +82314,58 @@ paths:
8198882314 - incident_settings_write
8198982315 x-unstable: '**Note**: This endpoint is in public beta.
8199082316
82317+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
82318+ /api/v2/incidents/import:
82319+ post:
82320+ description: 'Import an incident from an external system. This endpoint allows
82321+ you to create incidents with
82322+
82323+ historical data such as custom timestamps for detection, declaration, and
82324+ resolution.
82325+
82326+ Imported incidents do not execute integrations or notification rules.'
82327+ operationId: ImportIncident
82328+ parameters:
82329+ - $ref: '#/components/parameters/IncidentImportIncludeQueryParameter'
82330+ requestBody:
82331+ content:
82332+ application/json:
82333+ schema:
82334+ $ref: '#/components/schemas/IncidentImportRequest'
82335+ description: Incident import payload.
82336+ required: true
82337+ responses:
82338+ '201':
82339+ content:
82340+ application/json:
82341+ schema:
82342+ $ref: '#/components/schemas/IncidentImportResponse'
82343+ description: CREATED
82344+ '400':
82345+ $ref: '#/components/responses/BadRequestResponse'
82346+ '401':
82347+ $ref: '#/components/responses/UnauthorizedResponse'
82348+ '403':
82349+ $ref: '#/components/responses/ForbiddenResponse'
82350+ '404':
82351+ $ref: '#/components/responses/NotFoundResponse'
82352+ '429':
82353+ $ref: '#/components/responses/TooManyRequestsResponse'
82354+ security:
82355+ - apiKeyAuth: []
82356+ appKeyAuth: []
82357+ - AuthZ:
82358+ - incident_write
82359+ summary: Import an incident
82360+ tags:
82361+ - Incidents
82362+ x-codegen-request-body-name: body
82363+ x-permission:
82364+ operator: AND
82365+ permissions:
82366+ - incident_write
82367+ x-unstable: '**Note**: This endpoint is in Preview.
82368+
8199182369 If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8199282370 /api/v2/incidents/search:
8199382371 get:
0 commit comments