Maintenances

Overview

Available Operations

• delete - Delete Maintenance By ID

• update_by_id - Update Maintenance By ID

delete

Delete Maintenance By ID

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.maintenances.delete(statuspage_id="<id>", maintenance_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.MaintenancesDeleteMaintenanceByIDResponse

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_id

Update Maintenance By ID

Example Usage

from squadcast_sdk import SquadcastSDK
from squadcast_sdk.utils import parse_datetime


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

    res = ss_client.maintenances.update_by_id(statuspage_id="<id>", maintenance_id="<id>", title="<value>", note="<value>", start_time=parse_datetime("2024-07-22T17:12:15.919Z"), end_time=parse_datetime("2024-06-11T21:00:35.262Z"))

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
statuspage_id	str	✔️	N/A
maintenance_id	str	✔️	N/A
title	str	✔️	N/A
note	str	✔️	N/A
start_time	date	✔️	N/A
end_time	date	✔️	N/A
components	List[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.MaintenancesUpdateMaintenanceByIDResponse

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