StatusPages

Overview

Available Operations

• list - List Status Pages

• create - Create Status Page

• delete_by_id - Delete Status Page By ID

• get_by_id - Get Status Page By ID

• update - Update Status Page By ID

• list_statuses - List Status Page Statuses

list

List Status Pages

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.status_pages.list(page_size=301790, page_number=172386, filters_is_public="<value>", team_id="<id>")

    while res is not None:
        # Handle items

        res = res.next()

Parameters

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

Response

models.StatusPagesListStatusPagesResponse

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

Create Status Page

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.status_pages.create(name="<value>", domain_name="failing-convection.com", logo_url="https://snarling-season.info", timezone="Pacific/Chuuk", team_id="<id>", contact_email="<value>", owner_type="team", owner_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
name	str	✔️	N/A
domain_name	str	✔️	N/A
logo_url	str	✔️	N/A
timezone	str	✔️	N/A
team_id	str	✔️	N/A
contact_email	str	✔️	N/A
owner_type	models.V4StatusPagesCreateStatusPageRequestOwnerType	✔️	N/A
owner_id	str	✔️	N/A
description	Optional[str]	➖	N/A
is_public	Optional[bool]	➖	N/A
custom_domain_name	Optional[str]	➖	N/A
theme_color	Optional[models.V4StatusPagesNewStatusPageThemeColor]	➖	N/A
components	List[models.V4StatusPagesNewStatusPageComponentList]	➖	N/A
allow_webhook_subscription	Optional[bool]	➖	N/A
allow_components_subscription	Optional[bool]	➖	N/A
allow_maintenance_subscription	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.StatusPagesCreateStatusPageResponse

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_by_id

Delete Status Page By ID

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.status_pages.delete_by_id(statuspage_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.StatusPagesDeleteStatusPageByIDResponse

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

Get Status Page By ID

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.status_pages.get_by_id(statuspage_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.StatusPagesGetStatusPageByIDResponse

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 Status Page By ID

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.status_pages.update(statuspage_id="<id>", name="<value>", is_public=False, domain_name="blank-brief.info", team_id="<id>", theme_color={
        "primary": "<value>",
        "secondary": "<value>",
    }, contact_email="<value>", owner_type="<value>", owner_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
statuspage_id	str	✔️	N/A
name	str	✔️	N/A
is_public	bool	✔️	N/A
domain_name	str	✔️	N/A
team_id	str	✔️	N/A
theme_color	models.V4StatusPagesUpdateStatusPageByIDRequestThemeColor	✔️	N/A
contact_email	str	✔️	N/A
owner_type	str	✔️	N/A
owner_id	str	✔️	N/A
description	Optional[str]	➖	N/A
custom_domain_name	Optional[str]	➖	N/A
logo_url	Optional[str]	➖	N/A
timezone	Optional[str]	➖	N/A
allow_components_subscription	Optional[bool]	➖	N/A
allow_maintenance_subscription	Optional[bool]	➖	N/A
allow_webhook_subscription	Optional[bool]	➖	N/A
components	List[models.V4StatusPagesUpdateStatusPageByIDRequestComponent2]	➖	N/A
is_custom_domain_enabled	Optional[bool]	➖	N/A
hide_from_search_engines	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.StatusPagesUpdateStatusPageByIDResponse

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

list_statuses

List Status Page Statuses

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.status_pages.list_statuses(statuspage_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.StatusPagesListStatusPageStatusesResponse

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