Slos

Overview

Available Operations

list_all - Get All SLOs
create - Create SLO
update - Update SLO
remove - Remove SLO
get - Get SLO By ID
mark_affected - Mark SLO Affected

list_all

Returns all the SLOs of the passed owner_id in the params. 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.slos.list_all(owner_id="<id>", offset="<value>", limit="<value>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

owner_id

str

✔️

N/A

offset

str

✔️

N/A

limit

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.SLOGetAllSLOsResponse

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

This API will create SLO. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

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.slos.create(name="<value>", time_interval_type="rolling", service_ids=[
        "<value 1>",
    ], slis=[], target_slo=6924.37, start_time=parse_datetime("2023-06-03T10:41:05.981Z"), end_time=parse_datetime("2023-11-20T07:09:22.422Z"), duration_in_days=574042, owner_type="<value>", owner_id="<id>", slo_owner_id="<id>", slo_owner_type="squad")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

name

str

✔️

N/A

time_interval_type

models.V3SLOTimeIntervalType

✔️

N/A

service_ids

List[str]

✔️

N/A

slis

List[str]

✔️

N/A

target_slo

float

✔️

N/A

start_time

date

✔️

N/A

end_time

date

✔️

N/A

duration_in_days

int

✔️

N/A

owner_type

str

✔️

N/A

owner_id

str

✔️

N/A

slo_owner_id

str

✔️

N/A

slo_owner_type

models.V3SLOSLOOwnerType

✔️

N/A

description

Optional[str]

➖

N/A

tags

Optional[models.V3SLOCreateSLORequestTags]

➖

N/A

slo_monitoring_checks

List[models.V3SLOSLOMonitoringCheck]

➖

N/A

slo_actions

List[models.V3SLOSLOAction]

➖

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.SLOCreateSLOResponse

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

This API will update SLO. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

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.slos.update(slo_id=16112, owner_id_param="<value>", name="<value>", time_interval_type="rolling", service_ids=[
        "<value 1>",
        "<value 2>",
        "<value 3>",
    ], slis=[
        "<value 1>",
    ], target_slo=2464.03, start_time=parse_datetime("2025-10-31T03:29:37.701Z"), end_time=parse_datetime("2024-03-30T19:04:36.297Z"), duration_in_days=271064, owner_type="<value>", owner_id="<id>", slo_owner_id="<id>", slo_owner_type="user")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

slo_id

int

✔️

N/A

owner_id_param

str

✔️

N/A

name

str

✔️

N/A

time_interval_type

models.V3SLOTimeIntervalType

✔️

N/A

service_ids

List[str]

✔️

N/A

slis

List[str]

✔️

N/A

target_slo

float

✔️

N/A

start_time

date

✔️

N/A

end_time

date

✔️

N/A

duration_in_days

int

✔️

N/A

owner_type

str

✔️

N/A

owner_id

str

✔️

N/A

slo_owner_id

str

✔️

N/A

slo_owner_type

models.V3SLOSLOOwnerType

✔️

N/A

description

Optional[str]

➖

N/A

tags

Optional[models.V3SLOCreateSLORequestTags]

➖

N/A

slo_monitoring_checks

List[models.V3SLOSLOMonitoringCheck]

➖

N/A

slo_actions

List[models.V3SLOSLOAction]

➖

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.SLOUpdateSLOResponse

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

*/*

remove

Remove SLO from passed owner_id (team_id) in the params . Upon sccess the slo will be removed. 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.slos.remove(slo_id=938544, owner_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

slo_id

int

✔️

N/A

owner_id

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.SLORemoveSLOResponse

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

Returns a SLO details of the given sloID 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.slos.get(slo_id=586718, owner_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

slo_id

int

✔️

N/A

owner_id

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.SLOGetSLOByIDResponse

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

*/*

mark_affected

This endpoint is used for mark slo affected.

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.slos.mark_affected(slo_id=294670, owner_id_param="<value>", incident_id="<id>", slis=[
        "<value 1>",
        "<value 2>",
    ], error_budget_spent=3480.26, owner_type="<value>", owner_id="<id>", org_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter

Type

Required

Description

slo_id

int

✔️

N/A

owner_id_param

str

✔️

N/A

incident_id

str

✔️

N/A

slis

List[str]

✔️

N/A

error_budget_spent

float

✔️

N/A

owner_type

str

✔️

N/A

owner_id

str

✔️

N/A

org_id

str

✔️

N/A

retries

Optional[utils.RetryConfig]

➖

Configuration to override the default retry behavior of the client.

Response

models.SLOMarkSLOAffectedResponse

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

*/*

PreviousServices NextSnoozeNotifications

Last updated 8 days ago

Good morning

hashtagOverview

hashtagAvailable Operations

hashtaglist_all

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagcreate

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagupdate

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagremove

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagget

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

hashtagmark_affected

hashtagExample Usage

hashtagParameters

hashtagResponse

hashtagErrors

Overview

Available Operations

list_all

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

remove

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

mark_affected

Example Usage

Parameters

Response

Errors