Skip to content

Commit 80ff581

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 70e408f of spec repo
1 parent e580f1d commit 80ff581

File tree

92 files changed

+4697
-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

+4697
-337
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 378 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 related object types to include in the response
523+
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.
@@ -28988,6 +28999,321 @@ components:
2898828999
type: string
2898929000
x-enum-varnames:
2899029001
- INCIDENT_IMPACTS
29002+
IncidentImportFieldAttributes:
29003+
description: Dynamic fields for which selections can be made, with field names
29004+
as keys.
29005+
oneOf:
29006+
- $ref: '#/components/schemas/IncidentImportFieldAttributesSingleValue'
29007+
- $ref: '#/components/schemas/IncidentImportFieldAttributesMultipleValue'
29008+
IncidentImportFieldAttributesMultipleValue:
29009+
additionalProperties: false
29010+
description: A field with potentially multiple values selected.
29011+
properties:
29012+
value:
29013+
description: The multiple values selected for this field.
29014+
example:
29015+
- '1.0'
29016+
- '1.1'
29017+
items:
29018+
description: A value which has been selected for the parent field.
29019+
example: '1.1'
29020+
type: string
29021+
nullable: true
29022+
type: array
29023+
type: object
29024+
IncidentImportFieldAttributesSingleValue:
29025+
additionalProperties: false
29026+
description: A field with a single value selected.
29027+
properties:
29028+
value:
29029+
description: The single value selected for this field.
29030+
example: SEV-1
29031+
nullable: true
29032+
type: string
29033+
type: object
29034+
IncidentImportRelatedObject:
29035+
description: Object related to an incident that can be included in the response.
29036+
enum:
29037+
- last_modified_by_user
29038+
- created_by_user
29039+
- commander_user
29040+
- declared_by_user
29041+
- incident_type
29042+
type: string
29043+
x-enum-varnames:
29044+
- LAST_MODIFIED_BY_USER
29045+
- CREATED_BY_USER
29046+
- COMMANDER_USER
29047+
- DECLARED_BY_USER
29048+
- INCIDENT_TYPE
29049+
IncidentImportRelationships:
29050+
description: The relationships for an incident import request.
29051+
properties:
29052+
commander_user:
29053+
$ref: '#/components/schemas/NullableRelationshipToUser'
29054+
declared_by_user:
29055+
$ref: '#/components/schemas/NullableRelationshipToUser'
29056+
type: object
29057+
IncidentImportRequest:
29058+
description: Import request for an incident. Used to import historical incidents
29059+
from external systems.
29060+
properties:
29061+
data:
29062+
$ref: '#/components/schemas/IncidentImportRequestData'
29063+
required:
29064+
- data
29065+
type: object
29066+
IncidentImportRequestAttributes:
29067+
description: The incident's attributes for an import request.
29068+
properties:
29069+
declared:
29070+
description: Timestamp when the incident was declared.
29071+
example: '2025-01-01T00:00:00Z'
29072+
format: date-time
29073+
type: string
29074+
detected:
29075+
description: Timestamp when the incident was detected.
29076+
example: '2025-01-01T00:00:00Z'
29077+
format: date-time
29078+
type: string
29079+
fields:
29080+
additionalProperties:
29081+
$ref: '#/components/schemas/IncidentImportFieldAttributes'
29082+
description: A condensed view of the user-defined fields for which to create
29083+
initial selections.
29084+
example:
29085+
severity:
29086+
value: SEV-5
29087+
state:
29088+
value: active
29089+
type: object
29090+
incident_type_uuid:
29091+
description: A unique identifier that represents the incident type. If not
29092+
provided, the default incident type is used.
29093+
example: 00000000-0000-0000-0000-000000000000
29094+
type: string
29095+
resolved:
29096+
description: Timestamp when the incident was resolved. Can only be set when
29097+
the state field is set to 'resolved'.
29098+
example: '2025-01-01T01:00:00Z'
29099+
format: date-time
29100+
type: string
29101+
title:
29102+
description: The title of the incident that summarizes what happened.
29103+
example: Imported incident from external system
29104+
maxLength: 1024
29105+
type: string
29106+
visibility:
29107+
$ref: '#/components/schemas/IncidentImportVisibility'
29108+
required:
29109+
- title
29110+
type: object
29111+
IncidentImportRequestData:
29112+
description: Incident data for an import request.
29113+
properties:
29114+
attributes:
29115+
$ref: '#/components/schemas/IncidentImportRequestAttributes'
29116+
relationships:
29117+
$ref: '#/components/schemas/IncidentImportRelationships'
29118+
type:
29119+
$ref: '#/components/schemas/IncidentType'
29120+
required:
29121+
- type
29122+
- attributes
29123+
type: object
29124+
IncidentImportResponse:
29125+
description: Response with an incident.
29126+
properties:
29127+
data:
29128+
$ref: '#/components/schemas/IncidentImportResponseData'
29129+
included:
29130+
description: Included related resources that the user requested.
29131+
items:
29132+
$ref: '#/components/schemas/IncidentImportResponseIncludedItem'
29133+
readOnly: true
29134+
type: array
29135+
required:
29136+
- data
29137+
type: object
29138+
IncidentImportResponseAttributes:
29139+
description: The incident's attributes from an import response.
29140+
properties:
29141+
archived:
29142+
description: Timestamp when the incident was archived.
29143+
format: date-time
29144+
nullable: true
29145+
readOnly: true
29146+
type: string
29147+
case_id:
29148+
description: The incident case ID.
29149+
format: int64
29150+
nullable: true
29151+
type: integer
29152+
created:
29153+
description: Timestamp when the incident was created.
29154+
example: '2025-01-01T00:00:00Z'
29155+
format: date-time
29156+
readOnly: true
29157+
type: string
29158+
created_by_uuid:
29159+
description: UUID of the user who created the incident.
29160+
nullable: true
29161+
type: string
29162+
creation_idempotency_key:
29163+
description: A unique key used to ensure idempotent incident creation.
29164+
nullable: true
29165+
type: string
29166+
customer_impact_end:
29167+
description: Timestamp when customers were no longer impacted by the incident.
29168+
format: date-time
29169+
nullable: true
29170+
type: string
29171+
customer_impact_scope:
29172+
description: A summary of the impact customers experienced during the incident.
29173+
example: An example customer impact scope
29174+
nullable: true
29175+
type: string
29176+
customer_impact_start:
29177+
description: Timestamp when customers began to be impacted by the incident.
29178+
format: date-time
29179+
nullable: true
29180+
type: string
29181+
declared:
29182+
description: Timestamp when the incident was declared.
29183+
example: '2025-01-01T00:00:00Z'
29184+
format: date-time
29185+
nullable: true
29186+
type: string
29187+
declared_by_uuid:
29188+
description: UUID of the user who declared the incident.
29189+
nullable: true
29190+
type: string
29191+
detected:
29192+
description: Timestamp when the incident was detected.
29193+
example: '2025-01-01T00:00:00Z'
29194+
format: date-time
29195+
nullable: true
29196+
type: string
29197+
fields:
29198+
additionalProperties:
29199+
$ref: '#/components/schemas/IncidentFieldAttributes'
29200+
description: A condensed view of the user-defined fields attached to incidents.
29201+
example:
29202+
severity:
29203+
type: dropdown
29204+
value: SEV-5
29205+
type: object
29206+
incident_type_uuid:
29207+
description: A unique identifier that represents an incident type.
29208+
example: 00000000-0000-0000-0000-000000000000
29209+
type: string
29210+
is_test:
29211+
description: A flag indicating whether the incident is a test incident.
29212+
example: false
29213+
type: boolean
29214+
last_modified_by_uuid:
29215+
description: UUID of the user who last modified the incident.
29216+
nullable: true
29217+
type: string
29218+
modified:
29219+
description: Timestamp when the incident was last modified.
29220+
format: date-time
29221+
readOnly: true
29222+
type: string
29223+
non_datadog_creator:
29224+
$ref: '#/components/schemas/IncidentNonDatadogCreator'
29225+
notification_handles:
29226+
description: Notification handles that are notified of the incident during
29227+
update.
29228+
items:
29229+
$ref: '#/components/schemas/IncidentNotificationHandle'
29230+
nullable: true
29231+
type: array
29232+
public_id:
29233+
description: The monotonically increasing integer ID for the incident.
29234+
example: 1
29235+
format: int64
29236+
type: integer
29237+
resolved:
29238+
description: Timestamp when the incident's state was last changed from active
29239+
or stable to resolved or completed.
29240+
format: date-time
29241+
nullable: true
29242+
type: string
29243+
severity:
29244+
$ref: '#/components/schemas/IncidentSeverity'
29245+
state:
29246+
description: The state of the incident.
29247+
nullable: true
29248+
type: string
29249+
title:
29250+
description: The title of the incident that summarizes what happened.
29251+
example: A test incident title
29252+
type: string
29253+
visibility:
29254+
description: The incident visibility status.
29255+
nullable: true
29256+
type: string
29257+
required:
29258+
- title
29259+
type: object
29260+
IncidentImportResponseData:
29261+
description: Incident data from an import response.
29262+
properties:
29263+
attributes:
29264+
$ref: '#/components/schemas/IncidentImportResponseAttributes'
29265+
id:
29266+
description: The incident's ID.
29267+
example: 00000000-0000-0000-1234-000000000000
29268+
type: string
29269+
relationships:
29270+
$ref: '#/components/schemas/IncidentImportResponseRelationships'
29271+
type:
29272+
$ref: '#/components/schemas/IncidentType'
29273+
required:
29274+
- id
29275+
- type
29276+
type: object
29277+
IncidentImportResponseIncludedItem:
29278+
description: An object related to an incident that is included in the response.
29279+
oneOf:
29280+
- $ref: '#/components/schemas/IncidentUserData'
29281+
- $ref: '#/components/schemas/IncidentTypeObject'
29282+
IncidentImportResponseRelationships:
29283+
description: The incident's relationships from an import response.
29284+
properties:
29285+
attachments:
29286+
$ref: '#/components/schemas/RelationshipToIncidentAttachment'
29287+
commander_user:
29288+
$ref: '#/components/schemas/NullableRelationshipToUser'
29289+
created_by_user:
29290+
$ref: '#/components/schemas/RelationshipToUser'
29291+
declared_by_user:
29292+
$ref: '#/components/schemas/RelationshipToUser'
29293+
impacts:
29294+
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
29295+
incident_type:
29296+
$ref: '#/components/schemas/RelationshipToIncidentType'
29297+
integrations:
29298+
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
29299+
last_modified_by_user:
29300+
$ref: '#/components/schemas/RelationshipToUser'
29301+
responders:
29302+
$ref: '#/components/schemas/RelationshipToIncidentResponders'
29303+
user_defined_fields:
29304+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
29305+
type: object
29306+
IncidentImportVisibility:
29307+
default: organization
29308+
description: The visibility of the incident.
29309+
enum:
29310+
- organization
29311+
- private
29312+
example: organization
29313+
type: string
29314+
x-enum-varnames:
29315+
- ORGANIZATION
29316+
- PRIVATE
2899129317
IncidentIntegrationMetadataAttributes:
2899229318
description: Incident integration metadata's attributes for a create request.
2899329319
properties:
@@ -79700,6 +80026,58 @@ paths:
7970080026
- incident_settings_write
7970180027
x-unstable: '**Note**: This endpoint is in public beta.
7970280028

80029+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
80030+
/api/v2/incidents/import:
80031+
post:
80032+
description: 'Import an incident from an external system. This endpoint allows
80033+
you to create incidents with
80034+
80035+
historical data such as custom timestamps for detection, declaration, and
80036+
resolution.
80037+
80038+
Imported incidents do not execute integrations or notification rules.'
80039+
operationId: ImportIncident
80040+
parameters:
80041+
- $ref: '#/components/parameters/IncidentImportIncludeQueryParameter'
80042+
requestBody:
80043+
content:
80044+
application/json:
80045+
schema:
80046+
$ref: '#/components/schemas/IncidentImportRequest'
80047+
description: Incident import payload.
80048+
required: true
80049+
responses:
80050+
'201':
80051+
content:
80052+
application/json:
80053+
schema:
80054+
$ref: '#/components/schemas/IncidentImportResponse'
80055+
description: CREATED
80056+
'400':
80057+
$ref: '#/components/responses/BadRequestResponse'
80058+
'401':
80059+
$ref: '#/components/responses/UnauthorizedResponse'
80060+
'403':
80061+
$ref: '#/components/responses/ForbiddenResponse'
80062+
'404':
80063+
$ref: '#/components/responses/NotFoundResponse'
80064+
'429':
80065+
$ref: '#/components/responses/TooManyRequestsResponse'
80066+
security:
80067+
- apiKeyAuth: []
80068+
appKeyAuth: []
80069+
- AuthZ:
80070+
- incident_write
80071+
summary: Import an incident
80072+
tags:
80073+
- Incidents
80074+
x-codegen-request-body-name: body
80075+
x-permission:
80076+
operator: AND
80077+
permissions:
80078+
- incident_write
80079+
x-unstable: '**Note**: This endpoint is in Preview.
80080+
7970380081
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
7970480082
/api/v2/incidents/search:
7970580083
get:

0 commit comments

Comments
 (0)