Incidents.Postmortems

Overview

Available Operations

• remove - Delete Postmortem By Incident

• get_by_incident - Get Postmortem By Incident

• update_by_incident - Update Postmortem By Incident

remove

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

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

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.incidents.postmortems.remove(incident_id="<id>")

    # Handle response
    print(res)

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.PostmortemsDeletePostmortemByIncidentResponse

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_incident

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

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

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.incidents.postmortems.get_by_incident(incident_id="<id>")

    # Handle response
    print(res)

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.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	*/*

update_by_incident

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

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

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.incidents.postmortems.update_by_incident(incident_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
owner_id	Optional[str]	➖	N/A
postmortem	Optional[str]	➖	N/A
follow_ups	List[models.V3IncidentsPostmortemsPostmortemFollowUp]	➖	N/A
new_attachments	List[models.V3IncidentsPostmortemsPostmortemAttachmentRequest]	➖	N/A
title	Optional[str]	➖	N/A
status	Optional[models.V3IncidentsPostmortemsPostmortemStatus]	➖	Represents the status of a postmortem.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.PostmortemsUpdatePostmortemByIncidentResponse

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	*/*