Harness

NG SLOs

This contains APIs related to CRUD operations of SLOs (simple & composite)

Get SLO data

Securityx-api-key
Request
path Parameters
identifier
required
string

Identifier for the Entity.

accountIdentifier
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/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Update SLO data
Securityx-api-key 
Request 
path Parameters
identifier
required
string
Identifier for the Entity.


 
accountIdentifier
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: application/json
required
Details of the SLO to be updated


orgIdentifier
string
 
projectIdentifier
string
 
identifier
required
string
 
name
required
string
 
description
string
 
object
 
userJourneyRefs
required
Array of strings
 
required
object (SLOTargetDTO) 
 
type
required
string
 Enum: "Simple" "Composite"  
required
object (ServiceLevelObjectiveSpec) 
 
Array of objects (NotificationRuleRefDTO) 
 
errorBudgetCalculationPeriod
integer <int32> 
 
errorBudgetCalculationValidity
integer <int32> 
 
Responses 
400
Bad Request


500
Internal Server Error


default
Gets the updated SLO


put/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier}
Request samples 
application/json
{
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "userJourneyRefs": [
    ],
  • "sloTarget": {
    },
  • "type": "Simple",
  • "spec": {
    },
  • "notificationRuleRefs": [
    ],
  • "errorBudgetCalculationPeriod": 0,
  • "errorBudgetCalculationValidity": 0
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Delete SLO data
Securityx-api-key 
Request 
path Parameters
identifier
required
string
Identifier for the Entity.


 
accountIdentifier
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/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get onBoarding graph for composite slo
Securityx-api-key 
Request 
path Parameters
accountIdentifier
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: */*
required
Composite SLO spec which consists of list of SLO details


type
required
string
 
required
Array of objects (ServiceLevelObjectiveDetailsDTO)   [ 2 .. 30 ] items 
 
evaluationType
string
 Enum: "Window" "Request" "MetricLess"  
sloFormulaType
string
 Enum: "WeightedAverage" "LeastPerformance"  
Responses 
400
Bad Request


500
Internal Server Error


default
Gets the time series data points for composite slo onBoarding graph


post/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/composite-slo/onboarding-graph
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get SLO list view
Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
required
string
Organization Identifier for the Entity.


 
projectIdentifier
required
string
Project Identifier for the Entity.


 
query Parameters
pageNumber
integer <int32> 
 Default:  0
Page Index of the results to fetch.Default Value: 0


 
pageSize
integer <int32> 
 Default:  10
Results per page


 
Request Body schema: */*
userJourneyIdentifiers
Array of strings
 
monitoredServiceIdentifier
string
 
targetTypes
Array of strings
Items Enum: "Rolling" "Calender"  
errorBudgetRisks
Array of strings
Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"  
searchFilter
string
 
type
string
 Enum: "Simple" "Composite"  
object (SLOTargetFilterDTO) 
 
compositeSLOIdentifier
string
 
evaluationType
string
 Enum: "Window" "Request" "MetricLess"  
evaluationTypes
Array of strings
Items Enum: "Window" "Request" "MetricLess"  
childResource
boolean
 
envIdentifiers
Array of strings
 
Responses 
400
Bad Request


500
Internal Server Error


default
Gets the SLOs for list view


post/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/status-list
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get all SLOs
Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
orgIdentifier
required
string
Organization Identifier for the Entity.


 
projectIdentifier
required
string
Project Identifier for the Entity.


 
query Parameters
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
 
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/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Saves SLO data
Securityx-api-key 
Request 
path Parameters
accountIdentifier
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: application/json
required
Details of the SLO to be saved


orgIdentifier
string
 
projectIdentifier
string
 
identifier
required
string
 
name
required
string
 
description
string
 
object
 
userJourneyRefs
required
Array of strings
 
required
object (SLOTargetDTO) 
 
type
required
string
 Enum: "Simple" "Composite"  
required
object (ServiceLevelObjectiveSpec) 
 
Array of objects (NotificationRuleRefDTO) 
 
errorBudgetCalculationPeriod
integer <int32> 
 
errorBudgetCalculationValidity
integer <int32> 
 
Responses 
400
Bad Request


500
Internal Server Error


default
Gets the saved SLO


post/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2
Request samples 
application/json
{
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "tags": {
    },
  • "userJourneyRefs": [
    ],
  • "sloTarget": {
    },
  • "type": "Simple",
  • "spec": {
    },
  • "notificationRuleRefs": [
    ],
  • "errorBudgetCalculationPeriod": 0,
  • "errorBudgetCalculationValidity": 0
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to SLOs