incidents
Incidents
Overview
Available Operations
BulkAcknowledge - Bulk Acknowledge Incidents
Export - Incident Export
ExportAsync - Incident Export Async
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
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_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
Response
*operations.IncidentsBulkAcknowledgeIncidentsResponse, error
Errors
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
csvorjsonfile.Requires
access_tokenas aBearer {{token}}in theAuthorizationheader.Header field/value:
Content-Type:text/csv
Query Params:
Example Usage
Parameters
Response
*operations.IncidentsIncidentExportResponse, error
Errors
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
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
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
Response
*operations.IncidentsIncidentExportAsyncResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
request
✔️
The request object to use for the request.
Response
*operations.IncidentsBulkIncidentsPriorityUpdateResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
Response
*operations.IncidentsBulkResolveIncidentsResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
incidentID
string
✔️
N/A
Response
*operations.IncidentsGetIncidentByIDResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
incidentID
string
✔️
N/A
Response
*operations.IncidentsAcknowledgeIncidentResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
incidentID
string
✔️
N/A
value
string
✔️
N/A
Response
*operations.IncidentsMarkIncidentSloFalsePositiveResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
incidentID
string
✔️
N/A
Response
*operations.IncidentsIncidentPriorityUpdateResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.typecan be eitheruserorescalationpolicyorsquad
Example Usage
Parameters
incidentID
string
✔️
N/A
Response
*operations.IncidentsReassignIncidentResponse, error
Errors
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_tokenas aBearer {{token}}in theAuthorizationheader.Resolution Reason is mandatory / optional based on the organization feature settings (Only for Premium and Enterprise Orgs) Read more
Example Usage
Parameters
incidentID
string
✔️
N/A
Response
*operations.IncidentsResolveIncidentResponse, error
Errors
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
*/*
GetStatusByRequestIds
This endpoint is used to get the status of incidents given list of request_ids
Requires
access_tokenas aBearer {{token}}in theAuthorizationheader.
Response
The response contains the mapping from
request_idsto incident status.statusfield can be one of -suppressed,discarded,deduplicated,created,error.status is
errorif therequest_idis invalid. Bothincident_idandevent_idfield won't be present ifstatusiserrorstatus is
suppressedif the incident was suppressed due to suppression rules.status is
deduplicatedif the incident was deduplicated due to deduplication rules.status is
discardedif the incident was discarded due to some deduplication rule.incident_idfield won't be present ifstatusisdiscarded.otherwise, the status is
created
Example Usage
Parameters
Response
*operations.IncidentsGetIncidentsStatusByRequestidsResponse, error
Errors
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
*/*
GetAllPostmortems
This endpoint is used to get all postmortems.
Requires
access_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
fromDate
string
✔️
Provide date in RFC3339 format
toDate
string
✔️
Provide date in RFC3339 format
ownerID
string
✔️
Here owner_id represents team_id
limit
int64
✔️
N/A
Response
*operations.PostmortemsGetAllPostmortemsResponse, error
Errors
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
*/*
MarkAsTransient
Mark as Transient
Example Usage
Parameters
incidentID
string
✔️
N/A
Response
*operations.AptaMarkAsTransientResponse, error
Errors
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
*/*
UpdatePostmortem
This endpoint is used to update a postmortem by incident.
Requires
access_tokenas aBearer {{token}}in theAuthorizationheader.
Example Usage
Parameters
incidentID
string
✔️
N/A
v3IncidentsPostmortemsUpdatePostmortemRequest
✔️
N/A
Response
*operations.PostmortemsUpdatePostmortemByIncidentResponse, error
Errors
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
*/*
UnsnoozeNotifications
Unsnooze Incident Notifications
Example Usage
Parameters
incidentID
string
✔️
N/A
v3IncidentsSnoozeNotificationsUnsnoozeIncidentRequest
✔️
N/A
Response
*operations.SnoozeNotificationsUnsnoozeIncidentNotificationsResponse, error
Errors
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
*/*
Last updated