Runbooks

Overview

Available Operations

• attach - Attach Runbooks

• get_all_by_team - Get All Runbooks By Team

• create - Create Runbook

• delete - Remove Runbook

• get_by_id - Get Runbook By ID

• update - Update Runbook

attach

Attach Runbooks

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.runbooks.attach(incident_id="<id>", runbooks=[
        "<value 1>",
        "<value 2>",
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
incident_id	str	✔️	N/A
runbooks	List[str]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RunbooksAttachRunbooksResponse

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_all_by_team

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

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.runbooks.get_all_by_team()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RunbooksGetAllRunbooksByTeamResponse

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

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.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.runbooks.create(name="<value>", steps=[
        {
            "content": "<value>",
        },
    ], owner_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
name	str	✔️	The name of the runbook.
steps	List[models.V3RunbooksStep]	✔️	The steps that make up the runbook.
owner_id	str	✔️	The ID of the team that owns this runbook.
entity_owner	Optional[models.CommonV3EntityOwner]	➖	The owner of the entity.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RunbooksCreateRunbookResponse

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

delete

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

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.runbooks.delete(runbook_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
runbook_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

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_id

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.

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.runbooks.get_by_id(runbook_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
runbook_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RunbooksGetRunbookByIDResponse

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

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

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.runbooks.update(runbook_id="<id>", name="<value>", steps=[
        {
            "content": "<value>",
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
runbook_id	str	✔️	N/A
name	str	✔️	The name of the runbook.
steps	List[models.V3RunbooksStep]	✔️	The steps that make up the runbook.
entity_owner	Optional[models.CommonV3EntityOwner]	➖	The owner of the entity.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RunbooksUpdateRunbookResponse

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