incidents

Incidents

Overview

Available Operations

• bulk_acknowledge - Bulk Acknowledge Incidents
• export_incidents - Incident Export
• merge - Merge Incidents
• bulk_update_priority - Bulk Incidents Priority Update
• bulk_resolve - Bulk Resolve Incidents
• get_by_id - Get Incident by ID
• acknowledge - Acknowledge Incident
• mark_slo_false_positive - Mark Incident SLO False Positive
• update_priority - Incident Priority Update
• reassign - Reassign Incident
• resolve - Resolve Incident
• unmerge - Unmerge Incident
• get_status_by_request_ids - Get Incidents Status By RequestIDs

bulk_acknowledge

• This endpoint is used to bulk acknowledge the incident by IDs. The API can handle a maximum of 100 incident IDs in a single request with 10 such calls per minute."
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_ids	List[str]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsBulkAcknowledgeIncidentsResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

export_incidents

• This endpoint is used to export the incident details into a csv or json file.
• Requires access_token as a Bearer {{token}} in the Authorization header.
• Header field/value: Content-Type: text/csv

Query Params:

Example Usage

Parameters

Parameter	Type	Required	Description
start_time	date	✔️	N/A
end_time	date	✔️	N/A
type	models.V3IncidentsExportFormat	✔️	Defines the format of the export.
owner_id	str	✔️	N/A
status	List[str]	➖	N/A
services	List[str]	➖	N/A
sources	List[str]	➖	N/A
assigned_to	List[str]	➖	N/A
assigned_to_user_i_ds_and_their_squads	List[str]	➖	N/A
service_owner	Optional[str]	➖	N/A
priority	List[models.V3IncidentsIncidentPriority]	➖	N/A
tags	List[str]	➖	N/A
slo_affecting	Optional[models.V3IncidentsIncidentExportRequestSloAffecting]	➖	N/A
slos	List[int]	➖	N/A
is_starred	Optional[models.V3IncidentsIncidentExportRequestIsStarred]	➖	N/A
text_filter	Optional[str]	➖	N/A
notes	Optional[models.V3IncidentsIncidentExportRequestNotes]	➖	N/A
retrospectives	Optional[models.V3IncidentsIncidentExportRequestRetrospectives]	➖	N/A
sort_by	Optional[models.V3IncidentsIncidentExportRequestSortBy]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Errors

Error Type	Status Code	Content Type
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

merge

• This endpoint merges incidents under an existing parent incident or a newly created parent incident. A parent can have at most 100 child incidents in total.
• All selected child incidents must belong to the team specified by owner_id and must not be suppressed, already merged as a child, or a parent with child incidents.
• An existing parent incident must belong to the same team and must not be suppressed or already merged as a child.
• When using an existing parent, the parent and child incidents must all be resolved or all be open (triggered or acknowledged).
• When creating a new parent, provide at least two open child incidents and the new_incident details instead of parent_incident_id.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
request	models.IncidentsMergeIncidentsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsMergeIncidentsResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

bulk_update_priority

• This endpoint is used to bulk update incident priority.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_ids	List[str]	✔️	N/A
priority	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

bulk_resolve

• This endpoint is used to bulk resolve the incident by IDs. The API can handle a maximum of 100 incident IDs in a single request with 10 such calls per minute."
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_ids	List[str]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsBulkResolveIncidentsResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

get_by_id

• This endpoint is used to get the incident details by ID.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsGetIncidentByIDResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

acknowledge

• This endpoint is used to acknowledge the incident by ID.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsAcknowledgeIncidentResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

mark_slo_false_positive

• This endpoint is used to mark incident slo false positive.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
value	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsMarkIncidentSloFalsePositiveResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update_priority

• This endpoint is used to update incident priority by ID.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
priority	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsIncidentPriorityUpdateResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

reassign

• This endpoint is used to reassign the unresolved incident to any user or escalation policy or squads by ID.
• Requires access_token as a Bearer {{token}} in the Authorization header.
• type can be either user or escalationpolicy or squad

Example Usage

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
reassign_to	models.V3IncidentsAssignee	✔️	Assignment target for an incident.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsReassignIncidentResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

resolve

• This endpoint is used to resolve the incident by ID.
• Requires access_token as a Bearer {{token}} in the Authorization header.
• Resolution Reason is mandatory / optional based on the organization feature settings (Only for Premium and Enterprise Orgs) Read more

Example Usage

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
resolution_reason	models.ResolutionReason	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsResolveIncidentResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

unmerge

• This endpoint unmerges a child incident from its parent incident.
• The incident must currently be a child of a parent incident, and the parent incident must not be resolved or suppressed.
• send_notification: if true, sends notifications for the unmerged incident.
• assign_me: if true, assigns the unmerged incident to the requesting user. If false, the incident keeps its last assignee, provided that assignee still exists; otherwise the request fails and assign_me must be set to true.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
send_notification	bool	✔️	N/A
assign_me	bool	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.IncidentsUnmergeIncidentResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError