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

Incidents.Postmortems

Overview

Available Operations

getAll

  • This endpoint is used to get all postmortems.

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

Example Usage

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  refreshTokenAuth: "<YOUR_REFRESH_TOKEN_AUTH_HERE>",
});

async function run() {
  const result = await squadcastSDK.incidents.postmortems.getAll({
    fromDate: "<value>",
    toDate: "<value>",
    ownerId: "<id>",
    limit: 221553,
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

Parameters

Parameter
Type
Required
Description

request

✔️

The request object to use for the request.

options

RequestOptions

➖

Used to set various options for making HTTP requests.

options.fetchOptions

➖

Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

options.retries

➖

Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.PostmortemsGetAllPostmortemsResponse>

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

*/*

getByIncident

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

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

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Parameter
Type
Required
Description

request

✔️

The request object to use for the request.

options

RequestOptions

➖

Used to set various options for making HTTP requests.

options.fetchOptions

➖

Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

options.retries

➖

Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.PostmortemsGetPostmortemByIncidentResponse>

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

*/*

create

  • This endpoint is used to create a postmortem.

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

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Parameter
Type
Required
Description

request

✔️

The request object to use for the request.

options

RequestOptions

➖

Used to set various options for making HTTP requests.

options.fetchOptions

➖

Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

options.retries

➖

Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.PostmortemsCreatePostmortemResponse>

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

*/*

Last updated