Runbooks

Get All Runbooks By Team

get

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

/v3/runbooks

Returns all the runbooks of the team. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

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.Runbooks.ListByTeam(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "created": {
        "user_name": "text",
        "username_for_display": "text",
        "user_id": "text",
        "at": "2026-03-18T06:08:32.962Z",
        "entity_owner": {
          "id": "text",
          "type": "text"
        }
      },
      "updated": {
        "user_name": "text",
        "username_for_display": "text",
        "user_id": "text",
        "at": "2026-03-18T06:08:32.962Z",
        "entity_owner": {
          "id": "text",
          "type": "text"
        }
      },
      "used_count": 1,
      "steps": [
        {
          "content": "text"
        }
      ],
      "entity_owner": {
        "id": "text",
        "type": "text"
      },
      "organization_id": "text",
      "owner": {
        "id": "text",
        "type": "team"
      }
    }
  ]
}

Create Runbook

post

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

/v3/runbooks

Add runbook to the team. Returns the runbook object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Represents the request body for creating a new runbook.

namestringRequired

The name of the runbook.

owner_idstringRequired

The ID of the team that owns this runbook.

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

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.Runbooks.Create(ctx, components.V3RunbooksCreateRunbookRequest{
        Name: "<value>",
        Steps: []components.V3RunbooksStep{
            components.V3RunbooksStep{
                Content: "<value>",
            },
        },
        OwnerID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "created": {
      "user_name": "text",
      "username_for_display": "text",
      "user_id": "text",
      "at": "2026-03-18T06:08:32.962Z",
      "entity_owner": {
        "id": "text",
        "type": "text"
      }
    },
    "updated": {
      "user_name": "text",
      "username_for_display": "text",
      "user_id": "text",
      "at": "2026-03-18T06:08:32.962Z",
      "entity_owner": {
        "id": "text",
        "type": "text"
      }
    },
    "used_count": 1,
    "steps": [
      {
        "content": "text"
      }
    ],
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "organization_id": "text",
    "owner": {
      "id": "text",
      "type": "team"
    }
  }
}

Get Runbook By ID

get

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

/v3/runbooks/{runbookID}

Returns a runbook details of the given runbookID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

runbookIDstringRequired

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/runbooks/{runbookID}

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.Runbooks.GetByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "created": {
      "user_name": "text",
      "username_for_display": "text",
      "user_id": "text",
      "at": "2026-03-18T06:08:32.962Z",
      "entity_owner": {
        "id": "text",
        "type": "text"
      }
    },
    "updated": {
      "user_name": "text",
      "username_for_display": "text",
      "user_id": "text",
      "at": "2026-03-18T06:08:32.962Z",
      "entity_owner": {
        "id": "text",
        "type": "text"
      }
    },
    "used_count": 1,
    "steps": [
      {
        "content": "text"
      }
    ],
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "organization_id": "text",
    "owner": {
      "id": "text",
      "type": "team"
    }
  }
}

Update Runbook

put

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

/v3/runbooks/{runbookID}

Update runbook details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

runbookIDstringRequired

Body

application/json

Represents the request body for updating a runbook.

namestringRequired

The name of the runbook.

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/runbooks/{runbookID}

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.Runbooks.Update(ctx, "<id>", components.V3RunbooksUpdateRunbookRequest{
        Name: "<value>",
        Steps: []components.V3RunbooksStep{
            components.V3RunbooksStep{
                Content: "<value>",
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "name": "text",
    "created": {
      "user_name": "text",
      "username_for_display": "text",
      "user_id": "text",
      "at": "2026-03-18T06:08:32.962Z",
      "entity_owner": {
        "id": "text",
        "type": "text"
      }
    },
    "updated": {
      "user_name": "text",
      "username_for_display": "text",
      "user_id": "text",
      "at": "2026-03-18T06:08:32.962Z",
      "entity_owner": {
        "id": "text",
        "type": "text"
      }
    },
    "used_count": 1,
    "steps": [
      {
        "content": "text"
      }
    ],
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "organization_id": "text",
    "owner": {
      "id": "text",
      "type": "team"
    }
  }
}

Remove Runbook

delete

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

/v3/runbooks/{runbookID}

Remove runbook from team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

runbookIDstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

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/runbooks/{runbookID}

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.Runbooks.Remove(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}