Skip to content

Commit 8ee0cd3

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 6d70ab8 of spec repo
1 parent f87325c commit 8ee0cd3

File tree

92 files changed

+4808
-337
lines changed

Some content is hidden

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

92 files changed

+4808
-337
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 376 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -518,6 +518,17 @@ components:
518518
items:
519519
$ref: '#/components/schemas/IncidentImpactRelatedObject'
520520
type: array
521+
IncidentImportIncludeQueryParameter:
522+
description: Specifies which types of related objects should be included in
523+
the response when importing an incident.
524+
explode: false
525+
in: query
526+
name: include
527+
required: false
528+
schema:
529+
items:
530+
$ref: '#/components/schemas/IncidentImportRelatedObject'
531+
type: array
521532
IncidentIncludeQueryParameter:
522533
description: Specifies which types of related objects should be included in
523534
the response.
@@ -28781,6 +28792,319 @@ components:
2878128792
type: string
2878228793
x-enum-varnames:
2878328794
- INCIDENT_IMPACTS
28795+
IncidentImportFieldAttributes:
28796+
description: Dynamic fields for which selections can be made, with field names
28797+
as keys.
28798+
oneOf:
28799+
- $ref: '#/components/schemas/IncidentImportFieldAttributesSingleValue'
28800+
- $ref: '#/components/schemas/IncidentImportFieldAttributesMultipleValue'
28801+
IncidentImportFieldAttributesMultipleValue:
28802+
description: A field with potentially multiple values selected.
28803+
properties:
28804+
value:
28805+
description: The multiple values selected for this field.
28806+
example:
28807+
- '1.0'
28808+
- '1.1'
28809+
items:
28810+
description: A value which has been selected for the parent field.
28811+
example: '1.1'
28812+
type: string
28813+
nullable: true
28814+
type: array
28815+
type: object
28816+
IncidentImportFieldAttributesSingleValue:
28817+
description: A field with a single value selected.
28818+
properties:
28819+
value:
28820+
description: The single value selected for this field.
28821+
example: SEV-1
28822+
nullable: true
28823+
type: string
28824+
type: object
28825+
IncidentImportRelatedObject:
28826+
description: Object related to an incident that can be included in the response.
28827+
enum:
28828+
- last_modified_by_user
28829+
- created_by_user
28830+
- commander_user
28831+
- declared_by_user
28832+
- incident_type
28833+
type: string
28834+
x-enum-varnames:
28835+
- LAST_MODIFIED_BY_USER
28836+
- CREATED_BY_USER
28837+
- COMMANDER_USER
28838+
- DECLARED_BY_USER
28839+
- INCIDENT_TYPE
28840+
IncidentImportRelationships:
28841+
description: The relationships for an incident import request.
28842+
properties:
28843+
commander_user:
28844+
$ref: '#/components/schemas/NullableRelationshipToUser'
28845+
declared_by_user:
28846+
$ref: '#/components/schemas/NullableRelationshipToUser'
28847+
type: object
28848+
IncidentImportRequest:
28849+
description: Import request for an incident. Used to import historical incidents
28850+
from external systems.
28851+
properties:
28852+
data:
28853+
$ref: '#/components/schemas/IncidentImportRequestData'
28854+
required:
28855+
- data
28856+
type: object
28857+
IncidentImportRequestAttributes:
28858+
description: The incident's attributes for an import request.
28859+
properties:
28860+
declared:
28861+
description: Timestamp when the incident was declared.
28862+
example: '2025-01-01T00:00:00Z'
28863+
format: date-time
28864+
type: string
28865+
detected:
28866+
description: Timestamp when the incident was detected.
28867+
example: '2025-01-01T00:00:00Z'
28868+
format: date-time
28869+
type: string
28870+
fields:
28871+
additionalProperties:
28872+
$ref: '#/components/schemas/IncidentImportFieldAttributes'
28873+
description: A condensed view of the user-defined fields for which to create
28874+
initial selections.
28875+
example:
28876+
severity:
28877+
value: SEV-5
28878+
state:
28879+
value: active
28880+
type: object
28881+
incident_type_uuid:
28882+
description: A unique identifier that represents the incident type. If not
28883+
provided, the default incident type will be used.
28884+
example: 00000000-0000-0000-0000-000000000000
28885+
type: string
28886+
resolved:
28887+
description: Timestamp when the incident was resolved. Can only be set when
28888+
the state field is set to 'resolved'.
28889+
example: '2025-01-01T01:00:00Z'
28890+
format: date-time
28891+
type: string
28892+
title:
28893+
description: The title of the incident, which summarizes what happened.
28894+
example: Imported incident from external system
28895+
maxLength: 1024
28896+
type: string
28897+
visibility:
28898+
$ref: '#/components/schemas/IncidentImportVisibility'
28899+
required:
28900+
- title
28901+
type: object
28902+
IncidentImportRequestData:
28903+
description: Incident data for an import request.
28904+
properties:
28905+
attributes:
28906+
$ref: '#/components/schemas/IncidentImportRequestAttributes'
28907+
relationships:
28908+
$ref: '#/components/schemas/IncidentImportRelationships'
28909+
type:
28910+
$ref: '#/components/schemas/IncidentType'
28911+
required:
28912+
- type
28913+
- attributes
28914+
type: object
28915+
IncidentImportResponse:
28916+
description: Response with an incident.
28917+
properties:
28918+
data:
28919+
$ref: '#/components/schemas/IncidentImportResponseData'
28920+
included:
28921+
description: Included related resources that the user requested.
28922+
items:
28923+
$ref: '#/components/schemas/IncidentImportResponseIncludedItem'
28924+
readOnly: true
28925+
type: array
28926+
required:
28927+
- data
28928+
type: object
28929+
IncidentImportResponseAttributes:
28930+
description: The incident's attributes from an import response.
28931+
properties:
28932+
archived:
28933+
description: Timestamp of when the incident was archived.
28934+
format: date-time
28935+
nullable: true
28936+
readOnly: true
28937+
type: string
28938+
case_id:
28939+
description: The incident case id.
28940+
format: int64
28941+
nullable: true
28942+
type: integer
28943+
created:
28944+
description: Timestamp when the incident was created.
28945+
example: '2025-01-01T00:00:00Z'
28946+
format: date-time
28947+
readOnly: true
28948+
type: string
28949+
created_by_uuid:
28950+
description: UUID of the user who created the incident.
28951+
nullable: true
28952+
type: string
28953+
creation_idempotency_key:
28954+
description: A unique key used to ensure idempotent incident creation.
28955+
nullable: true
28956+
type: string
28957+
customer_impact_end:
28958+
description: Timestamp when customers were no longer impacted by the incident.
28959+
format: date-time
28960+
nullable: true
28961+
type: string
28962+
customer_impact_scope:
28963+
description: A summary of the impact customers experienced during the incident.
28964+
example: An example customer impact scope
28965+
nullable: true
28966+
type: string
28967+
customer_impact_start:
28968+
description: Timestamp when customers began being impacted by the incident.
28969+
format: date-time
28970+
nullable: true
28971+
type: string
28972+
declared:
28973+
description: Timestamp when the incident was declared.
28974+
example: '2025-01-01T00:00:00Z'
28975+
format: date-time
28976+
nullable: true
28977+
type: string
28978+
declared_by_uuid:
28979+
description: UUID of the user who declared the incident.
28980+
nullable: true
28981+
type: string
28982+
detected:
28983+
description: Timestamp when the incident was detected.
28984+
example: '2025-01-01T00:00:00Z'
28985+
format: date-time
28986+
nullable: true
28987+
type: string
28988+
fields:
28989+
additionalProperties:
28990+
$ref: '#/components/schemas/IncidentFieldAttributes'
28991+
description: A condensed view of the user-defined fields attached to incidents.
28992+
example:
28993+
severity:
28994+
type: dropdown
28995+
value: SEV-5
28996+
type: object
28997+
incident_type_uuid:
28998+
description: A unique identifier that represents an incident type.
28999+
example: 00000000-0000-0000-0000-000000000000
29000+
type: string
29001+
is_test:
29002+
description: A flag indicating whether the incident is a test incident.
29003+
example: false
29004+
type: boolean
29005+
last_modified_by_uuid:
29006+
description: UUID of the user who last modified the incident.
29007+
nullable: true
29008+
type: string
29009+
modified:
29010+
description: Timestamp when the incident was last modified.
29011+
format: date-time
29012+
readOnly: true
29013+
type: string
29014+
non_datadog_creator:
29015+
$ref: '#/components/schemas/IncidentNonDatadogCreator'
29016+
notification_handles:
29017+
description: Notification handles that will be notified of the incident
29018+
during update.
29019+
items:
29020+
$ref: '#/components/schemas/IncidentNotificationHandle'
29021+
nullable: true
29022+
type: array
29023+
public_id:
29024+
description: The monotonically increasing integer ID for the incident.
29025+
example: 1
29026+
format: int64
29027+
type: integer
29028+
resolved:
29029+
description: Timestamp when the incident's state was last changed from active
29030+
or stable to resolved or completed.
29031+
format: date-time
29032+
nullable: true
29033+
type: string
29034+
severity:
29035+
$ref: '#/components/schemas/IncidentSeverity'
29036+
state:
29037+
description: The state of the incident.
29038+
nullable: true
29039+
type: string
29040+
title:
29041+
description: The title of the incident, which summarizes what happened.
29042+
example: A test incident title
29043+
type: string
29044+
visibility:
29045+
description: The incident visibility status.
29046+
nullable: true
29047+
type: string
29048+
required:
29049+
- title
29050+
type: object
29051+
IncidentImportResponseData:
29052+
description: Incident data from an import response.
29053+
properties:
29054+
attributes:
29055+
$ref: '#/components/schemas/IncidentImportResponseAttributes'
29056+
id:
29057+
description: The incident's ID.
29058+
example: 00000000-0000-0000-1234-000000000000
29059+
type: string
29060+
relationships:
29061+
$ref: '#/components/schemas/IncidentImportResponseRelationships'
29062+
type:
29063+
$ref: '#/components/schemas/IncidentType'
29064+
required:
29065+
- id
29066+
- type
29067+
type: object
29068+
IncidentImportResponseIncludedItem:
29069+
description: An object related to an incident that is included in the response.
29070+
oneOf:
29071+
- $ref: '#/components/schemas/IncidentUserData'
29072+
- $ref: '#/components/schemas/IncidentTypeObject'
29073+
IncidentImportResponseRelationships:
29074+
description: The incident's relationships from an import response.
29075+
properties:
29076+
attachments:
29077+
$ref: '#/components/schemas/RelationshipToIncidentAttachment'
29078+
commander_user:
29079+
$ref: '#/components/schemas/NullableRelationshipToUser'
29080+
created_by_user:
29081+
$ref: '#/components/schemas/RelationshipToUser'
29082+
declared_by_user:
29083+
$ref: '#/components/schemas/RelationshipToUser'
29084+
impacts:
29085+
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
29086+
incident_type:
29087+
$ref: '#/components/schemas/RelationshipToIncidentType'
29088+
integrations:
29089+
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
29090+
last_modified_by_user:
29091+
$ref: '#/components/schemas/RelationshipToUser'
29092+
responders:
29093+
$ref: '#/components/schemas/RelationshipToIncidentResponders'
29094+
user_defined_fields:
29095+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
29096+
type: object
29097+
IncidentImportVisibility:
29098+
default: organization
29099+
description: The visibility of the incident.
29100+
enum:
29101+
- organization
29102+
- private
29103+
example: organization
29104+
type: string
29105+
x-enum-varnames:
29106+
- ORGANIZATION
29107+
- PRIVATE
2878429108
IncidentIntegrationMetadataAttributes:
2878529109
description: Incident integration metadata's attributes for a create request.
2878629110
properties:
@@ -79371,6 +79695,58 @@ paths:
7937179695
- incident_settings_write
7937279696
x-unstable: '**Note**: This endpoint is in public beta.
7937379697

79698+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
79699+
/api/v2/incidents/import:
79700+
post:
79701+
description: 'Import an incident from an external system. This endpoint allows
79702+
you to create incidents with
79703+
79704+
historical data such as custom timestamps for detection, declaration, and
79705+
resolution.
79706+
79707+
Imported incidents will not execute integrations or notification rules.'
79708+
operationId: ImportIncident
79709+
parameters:
79710+
- $ref: '#/components/parameters/IncidentImportIncludeQueryParameter'
79711+
requestBody:
79712+
content:
79713+
application/json:
79714+
schema:
79715+
$ref: '#/components/schemas/IncidentImportRequest'
79716+
description: Incident import payload.
79717+
required: true
79718+
responses:
79719+
'201':
79720+
content:
79721+
application/json:
79722+
schema:
79723+
$ref: '#/components/schemas/IncidentImportResponse'
79724+
description: CREATED
79725+
'400':
79726+
$ref: '#/components/responses/BadRequestResponse'
79727+
'401':
79728+
$ref: '#/components/responses/UnauthorizedResponse'
79729+
'403':
79730+
$ref: '#/components/responses/ForbiddenResponse'
79731+
'404':
79732+
$ref: '#/components/responses/NotFoundResponse'
79733+
'429':
79734+
$ref: '#/components/responses/TooManyRequestsResponse'
79735+
security:
79736+
- apiKeyAuth: []
79737+
appKeyAuth: []
79738+
- AuthZ:
79739+
- incident_write
79740+
summary: Import an incident
79741+
tags:
79742+
- Incidents
79743+
x-codegen-request-body-name: body
79744+
x-permission:
79745+
operator: AND
79746+
permissions:
79747+
- incident_write
79748+
x-unstable: '**Note**: This endpoint is in public beta.
79749+
7937479750
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
7937579751
/api/v2/incidents/search:
7937679752
get:

0 commit comments

Comments
 (0)