Harness

SLOs dashboard

This contains APIs related to SLOs dashboard

getSLOAssociatedEnvironmentIdentifiers

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
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

get/cv/api/slo-dashboard/environment-identifiers
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
getSLOAssociatedMonitoredServices
Securityx-api-key 
Request 
query Parameters
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
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


get/cv/api/slo-dashboard/monitored-services
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
getSecondaryEventDetails
Securityx-api-key 
Request 
query Parameters
accountId
required
string
Account Identifier for the Entity.


 
secondaryEventType
required
string
 Enum: "Downtime" "DataCollectionFailure" "Annotation" "ErrorBudgetReset" "SrmAnalysisImpact"  
identifiers
required
Array of strings  [ 1 .. 2147483647 ] items 
 
Responses 
400
Bad Request


500
Internal Server Error


get/cv/api/slo-dashboard/secondary-events-details
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
getSecondaryEvents
Securityx-api-key 
Request 
path Parameters
identifier
required
string
SLO identifier for the entity


 
query Parameters
startTime
required
integer <int64> 
 
endTime
required
integer <int64> 
 
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal Server Error


get/cv/api/slo-dashboard/secondary-events/{identifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get all SLOs count by risk
Securityx-api-key 
Request 
query Parameters
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
userJourneyIdentifiers
Array of strings
For filtering on the basis of user journeys' identifiers


 
monitoredServiceIdentifier
string
For filtering on the basis of monitored services' identifiers


 
targetTypes
Array of strings
For filtering on the basis of target types


Items Enum: "Rolling" "Calender"  
errorBudgetRisks
Array of strings
For filtering on the basis of error budget risks


Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"  
filter
string
For filtering on the basis of name


 
sloType
string
For filtering on the basis of SLO type


 Enum: "Simple" "Composite"  
evaluationType
string
For filtering on the basis of SLI Evaluation type


 Enum: "Window" "Request" "MetricLess"  
evaluationTypes
Array of strings
For filtering on the basis of SLI Evaluation types


Items Enum: "Window" "Request" "MetricLess"  
envIdentifiers
Array of strings
For Filtering on the basis of environment identifiers


 
Responses 
400
Bad Request


500
Internal Server Error


default
Get the risk count for all SLOs


get/cv/api/slo-dashboard/risk-count
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get SLO consumption breakdown
Securityx-api-key 
Request 
path Parameters
identifier
required
string
SLO identifier for the entity


 
query Parameters
startTime
required
integer <int64> 
 
endTime
required
integer <int64> 
 
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal Server Error


default
Gets the SLO's details


get/cv/api/slo-dashboard/widget/{identifier}/consumption
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get SLO dashboard details
Securityx-api-key 
Request 
path Parameters
identifier
required
string
SLO identifier for the entity


 
query Parameters
startTime
integer <int64> 
 
endTime
integer <int64> 
 
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal Server Error


default
Gets the SLO's details


get/cv/api/slo-dashboard/widget/{identifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get SLO list view
Securityx-api-key 
Request 
query Parameters
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
userJourneyIdentifiers
Array of strings
For filtering on the basis of user journeys' identifiers


 
monitoredServiceIdentifier
string
For filtering on the basis of monitored services' identifiers


 
targetTypes
Array of strings
For filtering on the basis of target types


Items Enum: "Rolling" "Calender"  
errorBudgetRisks
Array of strings
For filtering on the basis of error budget risks


Items Enum: "EXHAUSTED" "UNHEALTHY" "NEED_ATTENTION" "OBSERVE" "HEALTHY"  
filter
string
For filtering on the basis of name


 
sloType
string
For filtering on the basis of SLO type


 Enum: "Simple" "Composite"  
evaluationType
string
For filtering on the basis of SLI Evaluation type


 Enum: "Window" "Request" "MetricLess"  
evaluationTypes
Array of strings
For filtering on the basis of SLI Evaluation types


Items Enum: "Window" "Request" "MetricLess"  
envIdentifiers
Array of strings
For Filtering on the basis of environment identifiers


 
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 SLOs for list view


get/cv/api/slo-dashboard/widgets/list
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get SLO list view
Securityx-api-key 
Request 
query Parameters
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
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


 
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/slo-dashboard/widgets/list
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to NG SLOs