circle-info
Squadcast is now SolarWinds Incident Response

SLOs

Get All SLOs

get
/v3/slo

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
owner_idstringRequired
offsetstringRequired
limitstringRequired
Responses
chevron-right
200

The request has succeeded.

application/json
get
/v3/slo

Create SLO

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
descriptionstringOptional
time_interval_typestring · enumRequiredPossible values:
service_idsstring[]Required
slisstring[]Required
target_slonumber · floatRequired
start_timestring · date-timeRequired
end_timestring · date-timeRequired
duration_in_daysinteger · uint32Required
tagsobjectOptional
owner_typestringRequired
owner_idstringRequired
slo_owner_idstringRequired
slo_owner_typestring · enumRequiredPossible values:
Responses
post
/v3/slo

Get SLO By ID

get
/v3/slo/{sloID}

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sloIDintegerRequired
Query parameters
owner_idstringRequired
Responses
chevron-right
200

The request has succeeded.

application/json
get
/v3/slo/{sloID}

Update SLO

put
/v3/slo/{sloID}
  • This API will update SLO. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sloIDintegerRequired
Query parameters
owner_idstringRequired
Body
namestringRequired
descriptionstringOptional
time_interval_typestring · enumRequiredPossible values:
service_idsstring[]Required
slisstring[]Required
target_slonumber · floatRequired
start_timestring · date-timeRequired
end_timestring · date-timeRequired
duration_in_daysinteger · uint32Required
tagsobjectOptional
owner_typestringRequired
owner_idstringRequired
slo_owner_idstringRequired
slo_owner_typestring · enumRequiredPossible values:
Responses
chevron-right
200

The request has succeeded.

application/json
put
/v3/slo/{sloID}

Remove SLO

delete
/v3/slo/{sloID}

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sloIDintegerRequired
Query parameters
owner_idstringRequired
Responses
chevron-right
200

The request has succeeded.

application/json
delete
/v3/slo/{sloID}

Mark SLO Affected

post
/v3/slo/{sloID}/incident

This endpoint is used for mark slo affected.

Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sloIDintegerRequired
Query parameters
owner_idstringRequired
Body
incident_idstringRequired
slisstring[]Required
error_budget_spentnumber · floatRequired
owner_typestringRequired
owner_idstringRequired
org_idstringRequired
Responses
post
/v3/slo/{sloID}/incident

Mark SLO False Positive

patch
/v3/slo/{sloID}/incident/{incidentID}/false-positive/{value}

Value is a boolean (true or false)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sloIDintegerRequired
incidentIDintegerRequired
valuebooleanRequired
Query parameters
owner_idstringRequired
Body
objectOptional
Responses
chevron-right
200

The request has succeeded.

application/json
patch
/v3/slo/{sloID}/incident/{incidentID}/false-positive/{value}

Last updated