incidents

Incidents

Overview

Available Operations

• BulkAcknowledge - Bulk Acknowledge Incidents
• Export - Incident Export
• ExportAsync - Incident Export Async
• Merge - Merge Incidents
• BulkUpdatePriority - Bulk Incidents Priority Update
• BulkResolve - Bulk Resolve Incidents
• GetByID - Get Incident by ID
• Acknowledge - Acknowledge Incident
• MarkSloFalsePositive - Mark Incident SLO False Positive
• UpdatePriority - Incident Priority Update
• Reassign - Reassign Incident
• Resolve - Resolve Incident
• Unmerge - Unmerge Incident
• GetStatusByRequestIds - Get Incidents Status By RequestIDs
• GetAllPostmortems - Get All Postmortems
• MarkAsTransient - Mark as Transient
• UpdatePostmortem - Update Postmortem By Incident
• UnsnoozeNotifications - Unsnooze Incident Notifications

BulkAcknowledge

• 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
ctx	context.Context	✔️	The context to use for the request.
request	components.V3IncidentsBulkIncidentIDsRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsBulkAcknowledgeIncidentsResponse, error

Errors

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

Export

• 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
ctx	context.Context	✔️	The context to use for the request.
request	operations.IncidentsIncidentExportRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsIncidentExportResponse, error

Errors

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

ExportAsync

• This is an async API, once the request is made the export will start in our workers. You will get a download link to your registered Email ID once the export is completed

Payload

Key	Value	Example
type	csv / json	“csv”
start_time	Date in ISO Format	“2020-01-01T00:00:00.000Z”
end_time	Date in ISO Format	“2020-04-01T00:00:00.000Z”
owner_id	Team ID	“611262a9d5b4ea846b534a3f”

Incident Filters

Key	Value	Example
statuses	Array of triggered / resolved / acknowledged / suppressed	[“triggered”, “acknowleged”]
tags	Array of tags in format “KEY=VALUE”	[“severity=high”, “severity=low”]
sources	Array of Alert Source IDs	[“6077f7225fdc7075e371685f”]
services	Array of Service IDs	["62385fb309bc474014180828"]
assigned_to	Array of Assigned to user IDs	["625e40c9a9bd76370bf9f7fb"]

Example Usage

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	components.V3IncidentsIncidentExportAsyncRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsIncidentExportAsyncResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	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
ctx	context.Context	✔️	The context to use for the request.
request	operations.IncidentsMergeIncidentsRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsMergeIncidentsResponse, error

Errors

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

BulkUpdatePriority

• 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
ctx	context.Context	✔️	The context to use for the request.
request	components.V3IncidentsBulkIncidentsPriorityUpdateRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsBulkIncidentsPriorityUpdateResponse, error

Errors

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

BulkResolve

• 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
ctx	context.Context	✔️	The context to use for the request.
request	components.V3IncidentsBulkIncidentIDsRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsBulkResolveIncidentsResponse, error

Errors

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

GetByID

• 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
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsGetIncidentByIDResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	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
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsAcknowledgeIncidentResponse, error

Errors

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

MarkSloFalsePositive

• 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
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
value	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsMarkIncidentSloFalsePositiveResponse, error

Errors

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

UpdatePriority

• 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
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
v3IncidentsIncidentPriorityUpdateRequest	components.V3IncidentsIncidentPriorityUpdateRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsIncidentPriorityUpdateResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	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
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
v3IncidentsReassignIncidentRequest	components.V3IncidentsReassignIncidentRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsReassignIncidentResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	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
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
v3IncidentsResolveIncidentRequest	components.V3IncidentsResolveIncidentRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.IncidentsResolveIncidentResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json