Services.Maintenance

Overview

Available Operations

• create_or_update - Create or Update Maintenance Mode

create_or_update

Create or Update Maintenance Mode

Example Usage

from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.services.maintenance.create_or_update(service_id="<id>", on_maintenance=True, service_maintenance=[
        {
            "maintenance_start_date": "<value>",
            "daily": False,
            "weekly": True,
            "two_weekly": False,
            "three_weekly": True,
            "monthly": True,
            "deleted": False,
            "repeat_till": "<value>",
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
service_id	str	✔️	N/A
on_maintenance	bool	✔️	N/A
service_maintenance	List[models.V3ServicesMaintenanceModeServiceMaintenance]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.MaintenanceModeCreateOrUpdateMaintenanceModeResponse

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