Skip to content

Commit b9f9ddc

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 0b7cb5f of spec repo
1 parent 56853f8 commit b9f9ddc

File tree

105 files changed

+2350
-700
lines changed

Some content is hidden

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

105 files changed

+2350
-700
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 378 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,17 @@ components:
534534
items:
535535
$ref: '#/components/schemas/IncidentImpactRelatedObject'
536536
type: array
537+
IncidentImportIncludeQueryParameter:
538+
description: Specifies which related object types to include in the response
539+
when importing an incident.
540+
explode: false
541+
in: query
542+
name: include
543+
required: false
544+
schema:
545+
items:
546+
$ref: '#/components/schemas/IncidentImportRelatedObject'
547+
type: array
537548
IncidentIncludeQueryParameter:
538549
description: Specifies which types of related objects should be included in
539550
the response.
@@ -29825,6 +29836,321 @@ components:
2982529836
type: string
2982629837
x-enum-varnames:
2982729838
- INCIDENT_IMPACTS
29839+
IncidentImportFieldAttributes:
29840+
description: Dynamic fields for which selections can be made, with field names
29841+
as keys.
29842+
oneOf:
29843+
- $ref: '#/components/schemas/IncidentImportFieldAttributesSingleValue'
29844+
- $ref: '#/components/schemas/IncidentImportFieldAttributesMultipleValue'
29845+
IncidentImportFieldAttributesMultipleValue:
29846+
additionalProperties: false
29847+
description: A field with potentially multiple values selected.
29848+
properties:
29849+
value:
29850+
description: The multiple values selected for this field.
29851+
example:
29852+
- '1.0'
29853+
- '1.1'
29854+
items:
29855+
description: A value which has been selected for the parent field.
29856+
example: '1.1'
29857+
type: string
29858+
nullable: true
29859+
type: array
29860+
type: object
29861+
IncidentImportFieldAttributesSingleValue:
29862+
additionalProperties: false
29863+
description: A field with a single value selected.
29864+
properties:
29865+
value:
29866+
description: The single value selected for this field.
29867+
example: SEV-1
29868+
nullable: true
29869+
type: string
29870+
type: object
29871+
IncidentImportRelatedObject:
29872+
description: Object related to an incident that can be included in the response.
29873+
enum:
29874+
- last_modified_by_user
29875+
- created_by_user
29876+
- commander_user
29877+
- declared_by_user
29878+
- incident_type
29879+
type: string
29880+
x-enum-varnames:
29881+
- LAST_MODIFIED_BY_USER
29882+
- CREATED_BY_USER
29883+
- COMMANDER_USER
29884+
- DECLARED_BY_USER
29885+
- INCIDENT_TYPE
29886+
IncidentImportRelationships:
29887+
description: The relationships for an incident import request.
29888+
properties:
29889+
commander_user:
29890+
$ref: '#/components/schemas/NullableRelationshipToUser'
29891+
declared_by_user:
29892+
$ref: '#/components/schemas/NullableRelationshipToUser'
29893+
type: object
29894+
IncidentImportRequest:
29895+
description: Import request for an incident. Used to import historical incidents
29896+
from external systems.
29897+
properties:
29898+
data:
29899+
$ref: '#/components/schemas/IncidentImportRequestData'
29900+
required:
29901+
- data
29902+
type: object
29903+
IncidentImportRequestAttributes:
29904+
description: The incident's attributes for an import request.
29905+
properties:
29906+
declared:
29907+
description: Timestamp when the incident was declared.
29908+
example: '2025-01-01T00:00:00Z'
29909+
format: date-time
29910+
type: string
29911+
detected:
29912+
description: Timestamp when the incident was detected.
29913+
example: '2025-01-01T00:00:00Z'
29914+
format: date-time
29915+
type: string
29916+
fields:
29917+
additionalProperties:
29918+
$ref: '#/components/schemas/IncidentImportFieldAttributes'
29919+
description: A condensed view of the user-defined fields for which to create
29920+
initial selections.
29921+
example:
29922+
severity:
29923+
value: SEV-5
29924+
state:
29925+
value: active
29926+
type: object
29927+
incident_type_uuid:
29928+
description: A unique identifier that represents the incident type. If not
29929+
provided, the default incident type is used.
29930+
example: 00000000-0000-0000-0000-000000000000
29931+
type: string
29932+
resolved:
29933+
description: Timestamp when the incident was resolved. Can only be set when
29934+
the state field is set to 'resolved'.
29935+
example: '2025-01-01T01:00:00Z'
29936+
format: date-time
29937+
type: string
29938+
title:
29939+
description: The title of the incident that summarizes what happened.
29940+
example: Imported incident from external system
29941+
maxLength: 1024
29942+
type: string
29943+
visibility:
29944+
$ref: '#/components/schemas/IncidentImportVisibility'
29945+
required:
29946+
- title
29947+
type: object
29948+
IncidentImportRequestData:
29949+
description: Incident data for an import request.
29950+
properties:
29951+
attributes:
29952+
$ref: '#/components/schemas/IncidentImportRequestAttributes'
29953+
relationships:
29954+
$ref: '#/components/schemas/IncidentImportRelationships'
29955+
type:
29956+
$ref: '#/components/schemas/IncidentType'
29957+
required:
29958+
- type
29959+
- attributes
29960+
type: object
29961+
IncidentImportResponse:
29962+
description: Response with an incident.
29963+
properties:
29964+
data:
29965+
$ref: '#/components/schemas/IncidentImportResponseData'
29966+
included:
29967+
description: Included related resources that the user requested.
29968+
items:
29969+
$ref: '#/components/schemas/IncidentImportResponseIncludedItem'
29970+
readOnly: true
29971+
type: array
29972+
required:
29973+
- data
29974+
type: object
29975+
IncidentImportResponseAttributes:
29976+
description: The incident's attributes from an import response.
29977+
properties:
29978+
archived:
29979+
description: Timestamp when the incident was archived.
29980+
format: date-time
29981+
nullable: true
29982+
readOnly: true
29983+
type: string
29984+
case_id:
29985+
description: The incident case ID.
29986+
format: int64
29987+
nullable: true
29988+
type: integer
29989+
created:
29990+
description: Timestamp when the incident was created.
29991+
example: '2025-01-01T00:00:00Z'
29992+
format: date-time
29993+
readOnly: true
29994+
type: string
29995+
created_by_uuid:
29996+
description: UUID of the user who created the incident.
29997+
nullable: true
29998+
type: string
29999+
creation_idempotency_key:
30000+
description: A unique key used to ensure idempotent incident creation.
30001+
nullable: true
30002+
type: string
30003+
customer_impact_end:
30004+
description: Timestamp when customers were no longer impacted by the incident.
30005+
format: date-time
30006+
nullable: true
30007+
type: string
30008+
customer_impact_scope:
30009+
description: A summary of the impact customers experienced during the incident.
30010+
example: An example customer impact scope
30011+
nullable: true
30012+
type: string
30013+
customer_impact_start:
30014+
description: Timestamp when customers began to be impacted by the incident.
30015+
format: date-time
30016+
nullable: true
30017+
type: string
30018+
declared:
30019+
description: Timestamp when the incident was declared.
30020+
example: '2025-01-01T00:00:00Z'
30021+
format: date-time
30022+
nullable: true
30023+
type: string
30024+
declared_by_uuid:
30025+
description: UUID of the user who declared the incident.
30026+
nullable: true
30027+
type: string
30028+
detected:
30029+
description: Timestamp when the incident was detected.
30030+
example: '2025-01-01T00:00:00Z'
30031+
format: date-time
30032+
nullable: true
30033+
type: string
30034+
fields:
30035+
additionalProperties:
30036+
$ref: '#/components/schemas/IncidentFieldAttributes'
30037+
description: A condensed view of the user-defined fields attached to incidents.
30038+
example:
30039+
severity:
30040+
type: dropdown
30041+
value: SEV-5
30042+
type: object
30043+
incident_type_uuid:
30044+
description: A unique identifier that represents an incident type.
30045+
example: 00000000-0000-0000-0000-000000000000
30046+
type: string
30047+
is_test:
30048+
description: A flag indicating whether the incident is a test incident.
30049+
example: false
30050+
type: boolean
30051+
last_modified_by_uuid:
30052+
description: UUID of the user who last modified the incident.
30053+
nullable: true
30054+
type: string
30055+
modified:
30056+
description: Timestamp when the incident was last modified.
30057+
format: date-time
30058+
readOnly: true
30059+
type: string
30060+
non_datadog_creator:
30061+
$ref: '#/components/schemas/IncidentNonDatadogCreator'
30062+
notification_handles:
30063+
description: Notification handles that are notified of the incident during
30064+
update.
30065+
items:
30066+
$ref: '#/components/schemas/IncidentNotificationHandle'
30067+
nullable: true
30068+
type: array
30069+
public_id:
30070+
description: The monotonically increasing integer ID for the incident.
30071+
example: 1
30072+
format: int64
30073+
type: integer
30074+
resolved:
30075+
description: Timestamp when the incident's state was last changed from active
30076+
or stable to resolved or completed.
30077+
format: date-time
30078+
nullable: true
30079+
type: string
30080+
severity:
30081+
$ref: '#/components/schemas/IncidentSeverity'
30082+
state:
30083+
description: The state of the incident.
30084+
nullable: true
30085+
type: string
30086+
title:
30087+
description: The title of the incident that summarizes what happened.
30088+
example: A test incident title
30089+
type: string
30090+
visibility:
30091+
description: The incident visibility status.
30092+
nullable: true
30093+
type: string
30094+
required:
30095+
- title
30096+
type: object
30097+
IncidentImportResponseData:
30098+
description: Incident data from an import response.
30099+
properties:
30100+
attributes:
30101+
$ref: '#/components/schemas/IncidentImportResponseAttributes'
30102+
id:
30103+
description: The incident's ID.
30104+
example: 00000000-0000-0000-1234-000000000000
30105+
type: string
30106+
relationships:
30107+
$ref: '#/components/schemas/IncidentImportResponseRelationships'
30108+
type:
30109+
$ref: '#/components/schemas/IncidentType'
30110+
required:
30111+
- id
30112+
- type
30113+
type: object
30114+
IncidentImportResponseIncludedItem:
30115+
description: An object related to an incident that is included in the response.
30116+
oneOf:
30117+
- $ref: '#/components/schemas/IncidentUserData'
30118+
- $ref: '#/components/schemas/IncidentTypeObject'
30119+
IncidentImportResponseRelationships:
30120+
description: The incident's relationships from an import response.
30121+
properties:
30122+
attachments:
30123+
$ref: '#/components/schemas/RelationshipToIncidentAttachment'
30124+
commander_user:
30125+
$ref: '#/components/schemas/NullableRelationshipToUser'
30126+
created_by_user:
30127+
$ref: '#/components/schemas/RelationshipToUser'
30128+
declared_by_user:
30129+
$ref: '#/components/schemas/RelationshipToUser'
30130+
impacts:
30131+
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
30132+
incident_type:
30133+
$ref: '#/components/schemas/RelationshipToIncidentType'
30134+
integrations:
30135+
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
30136+
last_modified_by_user:
30137+
$ref: '#/components/schemas/RelationshipToUser'
30138+
responders:
30139+
$ref: '#/components/schemas/RelationshipToIncidentResponders'
30140+
user_defined_fields:
30141+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
30142+
type: object
30143+
IncidentImportVisibility:
30144+
default: organization
30145+
description: The visibility of the incident.
30146+
enum:
30147+
- organization
30148+
- private
30149+
example: organization
30150+
type: string
30151+
x-enum-varnames:
30152+
- ORGANIZATION
30153+
- PRIVATE
2982830154
IncidentIntegrationMetadataAttributes:
2982930155
description: Incident integration metadata's attributes for a create request.
2983030156
properties:
@@ -81741,6 +82067,58 @@ paths:
8174182067
- incident_settings_write
8174282068
x-unstable: '**Note**: This endpoint is in public beta.
8174382069

82070+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
82071+
/api/v2/incidents/import:
82072+
post:
82073+
description: 'Import an incident from an external system. This endpoint allows
82074+
you to create incidents with
82075+
82076+
historical data such as custom timestamps for detection, declaration, and
82077+
resolution.
82078+
82079+
Imported incidents do not execute integrations or notification rules.'
82080+
operationId: ImportIncident
82081+
parameters:
82082+
- $ref: '#/components/parameters/IncidentImportIncludeQueryParameter'
82083+
requestBody:
82084+
content:
82085+
application/json:
82086+
schema:
82087+
$ref: '#/components/schemas/IncidentImportRequest'
82088+
description: Incident import payload.
82089+
required: true
82090+
responses:
82091+
'201':
82092+
content:
82093+
application/json:
82094+
schema:
82095+
$ref: '#/components/schemas/IncidentImportResponse'
82096+
description: CREATED
82097+
'400':
82098+
$ref: '#/components/responses/BadRequestResponse'
82099+
'401':
82100+
$ref: '#/components/responses/UnauthorizedResponse'
82101+
'403':
82102+
$ref: '#/components/responses/ForbiddenResponse'
82103+
'404':
82104+
$ref: '#/components/responses/NotFoundResponse'
82105+
'429':
82106+
$ref: '#/components/responses/TooManyRequestsResponse'
82107+
security:
82108+
- apiKeyAuth: []
82109+
appKeyAuth: []
82110+
- AuthZ:
82111+
- incident_write
82112+
summary: Import an incident
82113+
tags:
82114+
- Incidents
82115+
x-codegen-request-body-name: body
82116+
x-permission:
82117+
operator: AND
82118+
permissions:
82119+
- incident_write
82120+
x-unstable: '**Note**: This endpoint is in Preview.
82121+
8174482122
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
8174582123
/api/v2/incidents/search:
8174682124
get:

0 commit comments

Comments
 (0)