Services

Overview

Available Operations

• get_all - Get All Services

• create - Create Service

• get_by_name - Get Services By Name

• get_by_id - Get Service By ID

• update - Update Service

• delete - Delete Service

• update_apta_config - Auto Pause Transient Alerts (APTA)

• create_or_update_iag_config - Intelligent Alert Grouping (IAG)

• update_notification_delay_config - Delayed Notification Config

get_all

Get All Services

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.get_all(owner_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.ServicesGetServicesResponse

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 Service

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.create(owner_id="<id>", name="<value>", escalation_policy_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
owner_id	str	✔️	N/A
name	str	✔️	N/A
escalation_policy_id	str	✔️	N/A
description	Optional[str]	➖	N/A
email_prefix	Optional[str]	➖	N/A
maintainer	Optional[models.V3ServicesServiceMaintainer]	➖	N/A
tags	List[models.V3ServicesServiceTag]	➖	N/A
auto_pause_transient_alerts_config	Optional[models.V3ServicesAPTAConfig]	➖	N/A
intelligent_alerts_grouping_config	Optional[models.V3ServicesIAGConfig]	➖	N/A
delay_notification_config	Optional[models.V3ServicesNotificationDelayConfigRequest]	➖	N/A
dedup_init_config	Optional[models.V3ServicesDedupInitConfig]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ServicesCreateServiceResponse

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_name

Get Services By Name

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.get_by_name(name="<value>", owner_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.ServicesGetServicesByNameResponse

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 Service By ID

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.get_by_id(service_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.ServicesGetServiceByIDResponse

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 Service

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.update(service_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
service_id	str	✔️	N/A
name	Optional[str]	➖	N/A
escalation_policy_id	Optional[str]	➖	N/A
description	Optional[str]	➖	N/A
email_prefix	Optional[str]	➖	N/A
maintainer	Optional[models.V3ServicesServiceMaintainer]	➖	N/A
tags	List[models.V3ServicesServiceTag]	➖	N/A
auto_pause_transient_alerts_config	Optional[models.V3ServicesAPTAConfig]	➖	N/A
intelligent_alerts_grouping_config	Optional[models.V3ServicesIAGConfig]	➖	N/A
delay_notification_config	Optional[models.V3ServicesNotificationDelayConfigRequest]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ServicesUpdateServiceResponse

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

Delete Service

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.delete(service_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
service_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	*/*

update_apta_config

Auto Pause Transient Alerts (APTA)

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.update_apta_config(service_id="<id>", is_enabled=False, timeout_in_mins=680029)

    # Handle response
    print(res)

Parameters

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

Response

models.ServicesCreateOrUpdateAPTAConfigResponse

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_or_update_iag_config

Intelligent Alert Grouping (IAG)

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.create_or_update_iag_config(service_id="<id>", is_enabled=True, rolling_window_in_mins=246036)

    # Handle response
    print(res)

Parameters

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

Response

models.ServicesCreateOrUpdateIAGConfigResponse

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_notification_delay_config

Delayed Notification Config

Example Usage

from squadcast_sdk import SquadcastSDK


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

    res = ss_client.services.update_notification_delay_config(service_id="<id>", is_enabled=False)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
service_id	str	✔️	N/A
is_enabled	bool	✔️	N/A
timezone	Optional[str]	➖	N/A
fixed_timeslot_config	Optional[models.V3ServicesNotificationDelayConfigRequestFixedTimeslotConfig]	➖	N/A
custom_timeslots_enabled	Optional[bool]	➖	N/A
custom_timeslots	Optional[models.V3ServicesNotificationDelayConfigRequestCustomTimeslots]	➖	N/A
assigned_to	Optional[models.V3ServicesNotificationDelayConfigRequestAssignedTo]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ServicesDelayedNotificationConfigResponse

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