Incidents/Postmortems

Get All Postmortems

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/incidents/postmortem

• This endpoint is used to get all postmortems.

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fromDatestringRequired

Provide date in RFC3339 format

toDatestringRequired

Provide date in RFC3339 format

owner_idstringRequired

Here owner_id represents team_id

limitintegerRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/incidents/postmortem

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Incidents.GetAllPostmortems(ctx, "<value>", "<value>", "<id>", 221553)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "result": [
        {
          "id": "text",
          "organization_id": "text",
          "incident_id": "text",
          "postmortem": "text",
          "follow_ups": [
            {
              "task": "text",
              "is_done": true
            }
          ],
          "created_at": "text",
          "title": "text",
          "status": "in_progress",
          "owner": {
            "id": "text",
            "type": "team"
          },
          "access_control": [
            {
              "user_id": "text",
              "abilities": {}
            }
          ],
          "attachments": [
            "text"
          ],
          "incident": {
            "message": "text",
            "time_of_creation": "text"
          },
          "incident_message": "text",
          "incident_time_of_creation": "text",
          "service_name": "text",
          "service_id": "text",
          "alert_source": "text",
          "active_follow_ups_count": 1
        }
      ],
      "total_count": [
        {
          "count": 1
        }
      ]
    }
  ]
}

Get Postmortem By Incident

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/incidents/{incidentID}/postmortem

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

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

incidentIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/incidents/{incidentID}/postmortem

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Incidents.Postmortems.GetByIncident(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "organization_id": "text",
    "incident_id": "text",
    "postmortem": "text",
    "follow_ups": [
      {
        "task": "text",
        "is_done": true
      }
    ],
    "created_at": "text",
    "title": "text",
    "status": "in_progress",
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ],
    "attachments": [
      "text"
    ],
    "incident": {
      "message": "text",
      "time_of_creation": "text"
    }
  }
}

Create Postmortem

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/incidents/{incidentID}/postmortem

• This endpoint is used to create a postmortem.

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

incidentIDstringRequired

Body

application/json

Request body for creating a new postmortem.

owner_idstringRequired

titlestringRequired

postmortemstringRequired

statusstring · enumRequired

Represents the status of a postmortem.

Possible values:

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/incidents/{incidentID}/postmortem

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Incidents.Postmortems.Create(ctx, "<id>", components.V3IncidentsPostmortemsCreatePostmortemRequest{
        OwnerID: "<id>",
        Title: "<value>",
        Postmortem: "<value>",
        Status: components.V3IncidentsPostmortemsPostmortemStatusPublished,
        FollowUps: []components.V3IncidentsPostmortemsPostmortemFollowUp{},
        Attachments: []components.V3IncidentsPostmortemsPostmortemAttachmentRequest{
            components.V3IncidentsPostmortemsPostmortemAttachmentRequest{},
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "body": {
    "data": {
      "id": "text",
      "organization_id": "text",
      "incident_id": "text",
      "postmortem": "text",
      "follow_ups": [
        {
          "task": "text",
          "is_done": true
        }
      ],
      "created_at": "text",
      "title": "text",
      "status": "in_progress",
      "owner": {
        "id": "text",
        "type": "team"
      },
      "access_control": [
        {
          "user_id": "text",
          "abilities": {}
        }
      ],
      "attachments": [
        "text"
      ],
      "incident": {
        "message": "text",
        "time_of_creation": "text"
      }
    }
  }
}

Update Postmortem By Incident

put

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/incidents/{incidentID}/postmortem

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

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

incidentIDstringRequired

Body

application/json

Request body for updating an existing postmortem.

owner_idstringOptional

postmortemstringOptional

titlestringOptional

statusstring · enumOptional

Represents the status of a postmortem.

Possible values:

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put

/v3/incidents/{incidentID}/postmortem

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Incidents.UpdatePostmortem(ctx, "<id>", components.V3IncidentsPostmortemsUpdatePostmortemRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "organization_id": "text",
    "incident_id": "text",
    "postmortem": "text",
    "follow_ups": [
      {
        "task": "text",
        "is_done": true
      }
    ],
    "created_at": "text",
    "title": "text",
    "status": "in_progress",
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ],
    "attachments": [
      "text"
    ],
    "incident": {
      "message": "text",
      "time_of_creation": "text"
    }
  }
}

Delete Postmortem By Incident

delete

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/incidents/{incidentID}/postmortem

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

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

incidentIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete

/v3/incidents/{incidentID}/postmortem

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Incidents.Postmortems.DeleteByIncident(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "organization_id": "text",
    "incident_id": "text",
    "postmortem": "text",
    "follow_ups": [
      {
        "task": "text",
        "is_done": true
      }
    ],
    "created_at": "text",
    "title": "text",
    "status": "in_progress",
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ],
    "attachments": [
      "text"
    ],
    "incident": {
      "message": "text",
      "time_of_creation": "text"
    }
  }
}