SLOs

This contains APIs related to CRUD operations of SLOs

Delete SLO data

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Returns true if the SLO is deleted

delete/cv/api/slo/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get all SLOs

SecurityApiKey
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

offset
required
integer <int32>

Page Index of the results to fetch.Default Value: 0

pageSize
required
integer <int32>

Results per page

userJourneys
Array of strings
identifiers
Array of strings
sliTypes
Array of strings
Items Enum: "Availability" "Latency"
targetTypes
Array of strings
Items Enum: "Rolling" "Calender"
errorBudgetRisks
Array of strings
Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"
Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLOs

get/cv/api/slo
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get Error budget reset history

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Gets the error budget reset history

get/cv/api/slo/{identifier}/errorBudgetResetHistory
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get notification rules for SLO

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

pageNumber
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32>
Default: 10

Results per page

Responses
400

Bad Request

500

Internal Server Error

default

Gets the notification rules for SLO

get/cv/api/slo/{identifier}/notification-rules
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get SLO data

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLO's data

get/cv/api/slo/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get SLO logs

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

logType
required
string
Enum: "ApiCallLog" "ExecutionLog"
errorLogsOnly
boolean
startTime
required
integer <int64>
endTime
required
integer <int64>
pageNumber
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32>
Default: 10

Results per page

Responses
400

Bad Request

500

Internal Server Error

default

Gets the SLO's logs

get/cv/api/slo/{identifier}/logs
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Reset Error budget history

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Request Body schema: */*

Details needed to reset error budget

serviceLevelObjectiveIdentifier
string
errorBudgetIncrementPercentage
number <double>
errorBudgetIncrementMinutes
integer <int32>
remainingErrorBudgetAtReset
integer <int32>
errorBudgetAtReset
integer <int32>
reason
string
validUntil
integer <int64>
createdAt
integer <int64>
Responses
400

Bad Request

500

Internal Server Error

default

Reset Error budget history

post/cv/api/slo/{identifier}/resetErrorBudget
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Saves SLO data

SecurityApiKey
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

Request Body schema: */*

Details of the SLO to be saved

orgIdentifier
required
string
projectIdentifier
required
string
identifier
required
string
name
required
string
description
string
object
userJourneyRef
required
string
monitoredServiceRef
required
string
healthSourceRef
required
string
type
string
Enum: "Availability" "Latency"
required
Array of objects (ServiceLevelIndicatorDTO)
required
object (SLOTargetDTO)
Array of objects (NotificationRuleRefDTO)
Responses
400

Bad Request

500

Internal Server Error

default

Gets the saved SLO

post/cv/api/slo
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update SLO data

SecurityApiKey
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Request Body schema: */*

Details of the SLO to be updated

orgIdentifier
required
string
projectIdentifier
required
string
identifier
required
string
name
required
string
description
string
object
userJourneyRef
required
string
monitoredServiceRef
required
string
healthSourceRef
required
string
type
string
Enum: "Availability" "Latency"
required
Array of objects (ServiceLevelIndicatorDTO)
required
object (SLOTargetDTO)
Array of objects (NotificationRuleRefDTO)
Responses
400

Bad Request

500

Internal Server Error

default

Gets the updated SLO

put/cv/api/slo/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}