Skip to content
Squadcast is now SolarWinds Incident Response
For the complete documentation index, see llms.txt. This page is also available as Markdown.

incidents

Incidents

Overview

Available Operations

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

✔️

The context to use for the request.

request

✔️

The request object to use for the request.

opts

➖

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

✔️

The context to use for the request.

request

✔️

The request object to use for the request.

opts

➖

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

✔️

The context to use for the request.

request

✔️

The request object to use for the request.

opts

➖

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

✔️

The context to use for the request.

request

✔️

The request object to use for the request.

opts

➖

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

✔️

The context to use for the request.

request

✔️

The request object to use for the request.

opts

➖

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

✔️

The context to use for the request.

request

✔️

The request object to use for the request.

opts

➖

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

✔️

The context to use for the request.

incidentID

string

✔️

N/A

opts

➖

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

✔️

The context to use for the request.

incidentID

string

✔️

N/A

opts

➖

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

✔️

The context to use for the request.

incidentID

string

✔️

N/A

value

string

✔️

N/A

opts

➖

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

✔️

The context to use for the request.

incidentID

string

✔️

N/A

v3IncidentsIncidentPriorityUpdateRequest

✔️

N/A

opts

➖

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

✔️

The context to use for the request.

incidentID

string

✔️

N/A

v3IncidentsReassignIncidentRequest

✔️

N/A

opts

➖

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

✔️

The context to use for the request.

incidentID

string

✔️

N/A

v3IncidentsResolveIncidentRequest

✔️

N/A

opts

➖

The options for this request.

Response

*operations.IncidentsResolveIncidentResponse, 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

*/*

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

ctx

✔️

The context to use for the request.

incidentID

string

✔️

N/A

v3IncidentsUnmergeIncidentRequest

✔️

N/A

opts

➖

The options for this request.

Response

*operations.IncidentsUnmergeIncidentResponse, 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

*/*

GetStatusByRequestIds

  • This endpoint is used to get the status of incidents given list of request_ids

  • Requires access_token as a Bearer {{token}} in the Authorization header.

Response

  • The response contains the mapping from request_ids to incident status.

  • status field can be one of - suppressed, discarded, deduplicated, created, error.

  • status is error if the request_id is invalid. Both incident_id and event_id field won't be present if status is error

  • status is suppressed if the incident was suppressed due to suppression rules.

  • status is deduplicated if the incident was deduplicated due to deduplication rules.

  • status is discarded if the incident was discarded due to some deduplication rule. incident_id field won't be present if status is discarded.

  • otherwise, the status is created

Example Usage

Parameters

Parameter
Type
Required
Description

ctx

✔️

The context to use for the request.

request

✔️

The request object to use for the request.

opts

➖

The options for this request.

Response

*operations.IncidentsGetIncidentsStatusByRequestidsResponse, 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

*/*

GetAllPostmortems

  • This endpoint is used to get all postmortems.

  • Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter
Type
Required
Description

ctx

✔️

The context to use for the request.

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

opts

➖

The options for this request.

Response

*operations.PostmortemsGetAllPostmortemsResponse, 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

*/*

MarkAsTransient

Mark as Transient

Example Usage

Parameters

Parameter
Type
Required
Description

ctx

✔️

The context to use for the request.

incidentID

string

✔️

N/A

opts

➖

The options for this request.

Response

*operations.AptaMarkAsTransientResponse, 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

*/*

UpdatePostmortem

  • This endpoint is used to update a postmortem by incident.

  • Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

Parameters

Parameter
Type
Required
Description

ctx

✔️

The context to use for the request.

incidentID

string

✔️

N/A

v3IncidentsPostmortemsUpdatePostmortemRequest

✔️

N/A

opts

➖

The options for this request.

Response

*operations.PostmortemsUpdatePostmortemByIncidentResponse, 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

*/*

UnsnoozeNotifications

Unsnooze Incident Notifications

Example Usage

Parameters

Parameter
Type
Required
Description

ctx

✔️

The context to use for the request.

incidentID

string

✔️

N/A

v3IncidentsSnoozeNotificationsUnsnoozeIncidentRequest

✔️

N/A

opts

➖

The options for this request.

Response

*operations.SnoozeNotificationsUnsnoozeIncidentNotificationsResponse, 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

*/*

Last updated