Harness

SLOs

This contains APIs related to CRUD operations of SLOs

Get Error budget reset history

Securityx-api-key
Request
path Parameters
identifier
required
string

SLO identifier for the entity

query Parameters
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 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
Securityx-api-key 
Request 
path Parameters
identifier
required
string
SLO identifier for the entity


 
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


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 logs
Securityx-api-key 
Request 
path Parameters
identifier
required
string
SLO identifier for the entity


 
query Parameters
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
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
Securityx-api-key 
Request 
path Parameters
identifier
required
string
SLO identifier for the entity


 
query Parameters
accountId
required
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: */*
required
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": [
    ]
}
Get Metric Graph For SLO
Get Underlying Metrics Graph for SLO


Securityx-api-key 
Request 
path Parameters
org
required
string
Organization identifier


 
project
required
string
Project identifier


 
slo-identifier
required
string
SLO identifier.


 
query Parameters
start_time
integer <int64> 
Start Time for the metric graphs. 


 
end_time
integer <int64> 
End Time for the metric graphs.


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
Metric Graph response


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


502
Bad Gateway


get/cv/api/v1/orgs/{org}/projects/{project}/metric-graph/{slo-identifier}
Request samples 
Response samples 
application/json
[
  • {
    }
]
List SLOs
Returns a list of Service Level Objectives


Securityx-api-key 
Request 
path Parameters
org
required
string
Organization identifier


 
project
required
string
Project identifier


 
query Parameters
page
integer <int32> 
 Default:  0
Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.


 
limit
integer <int32>   <= 100 
 Default:  20
Pagination: Number of items to return.


 
composite_slo_identifier
string
Identifier for the Composite SLO for which underlying SLOs needs to be listed.


 
monitored_service_identifier
string
For filtering on the basis of monitored service identifier


 
user_journey_identifiers
Array of strings
List of User Journey identifiers on the basis of which the SLOs are filtered.


 
filter
string^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$
SLO Name on the basis of which the SLOs are filtered.


 
slo_type
string  [ 0 .. 1024 ] characters 
SLO Types on the basis of which the SLOs are filtered.


 
env_identifiers
Array of strings  [ 0 .. 128 ] items 
Identifiers of Environments on the basis of which the SLOs are filtered.


 
target_types
Array of strings
Target Types on the basis of which the SLOs are filtered.


 
error_budget_risks
Array of strings
Error Budgets on the basis of which the SLOs are filtered.


 
evaluation_type
string
Evaluation Type on the basis of which the SLOs are filtered.


 
child_resource
boolean
 Default:  false
For filtering the simple slo's on the basis of accountId. Set it to true for Account Level SLOs.


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
SLO List Response body


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


502
Bad Gateway


get/cv/api/v1/orgs/{org}/projects/{project}/slo
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Downtime