Monitored Services

This contains APIs related to CRUD operations of Monitored Services

createDefaultMonitoredService

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.

environmentIdentifier
required
string
serviceIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

post/cv/api/monitored-service/create-default
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

CvgetAnomaliesSummary

SecurityApiKey
Request
path Parameters
identifier
required
string
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.

startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
400

Bad Request

500

Internal Server Error

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

Delete monitored service data

SecurityApiKey
Request
path Parameters
identifier
required
string

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

Delete monitored service data

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

Get monitored service data

SecurityApiKey
Request
path Parameters
identifier
required
string
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

Get monitored service data

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

Get notification rules for MonitoredService

SecurityApiKey
Request
path Parameters
identifier
required
string

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

Get notification rules for MonitoredService

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

getAllMonitoredServicesWithHealthSources

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.

Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/all/time-series-health-sources
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getCountOfServices

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.

environmentIdentifier
string
filter
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/count-of-services
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getEnvironments

SecurityApiKey
Request
query Parameters
accountId
required
string
orgIdentifier
required
string
projectIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

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

getHealthSources

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.

serviceIdentifier
required
string
environmentIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/health-sources
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getHealthSourcesForMonitoredServiceIdentifier

SecurityApiKey
Request
path Parameters
monitoredServiceIdentifier
required
string
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

get/cv/api/monitored-service/{monitoredServiceIdentifier}/health-sources
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getList

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.

environmentIdentifier
string
environmentIdentifiers
Array of strings
offset
required
integer <int32>
pageSize
required
integer <int32>
filter
string
Responses
400

Bad Request

500

Internal Server Error

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

getMonitoredServiceChangeDetails

SecurityApiKey
Request
path Parameters
monitoredServiceIdentifier
required
string
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.

sloIdentifiers
Array of strings
startTime
integer <int64>
endTime
integer <int64>
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{monitoredServiceIdentifier}/change-details
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceDetails

SecurityApiKey
Request
path Parameters
monitoredServiceIdentifier
required
string
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

get/cv/api/monitored-service/{monitoredServiceIdentifier}/service-details
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceDetails_1Deprecated

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.

serviceIdentifier
required
string
environmentIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

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

getMonitoredServiceFromServiceAndEnvironment

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.

serviceIdentifier
required
string
environmentIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

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

getMonitoredServiceLogs

SecurityApiKey
Request
path Parameters
monitoredServiceIdentifier
required
string
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>
healthSources
Array of strings
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/monitored-service/{monitoredServiceIdentifier}/logs
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceScore

SecurityApiKey
Request
path Parameters
identifier
required
string
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

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

getOverAllHealthScore

SecurityApiKey
Request
path Parameters
identifier
required
string
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.

duration
required
string
Enum: "FOUR_HOURS" "TWENTY_FOUR_HOURS" "THREE_DAYS" "SEVEN_DAYS" "THIRTY_DAYS"
endTime
required
integer <int64>
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{identifier}/overall-health-score
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getSloMetrics

SecurityApiKey
Request
path Parameters
monitoredServiceIdentifier
required
string
healthSourceIdentifier
required
string
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

get/cv/api/monitored-service/{monitoredServiceIdentifier}/health-source/{healthSourceIdentifier}/slo-metrics
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

list

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.

environmentIdentifier
string
offset
required
integer <int32>
pageSize
required
integer <int32>
filter
string
servicesAtRiskFilter
required
boolean
Responses
400

Bad Request

500

Internal Server Error

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

saveMonitoredServiceFromYaml

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.

Request Body schema: */*
string
Responses
400

Bad Request

500

Internal Server Error

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

Saves monitored service data

SecurityApiKey
Request
query Parameters
accountId
required
string
Request Body schema: */*
orgIdentifier
required
string
projectIdentifier
required
string
identifier
required
string
name
required
string
type
required
string
Enum: "Application" "Infrastructure"
description
string
serviceRef
required
string
environmentRef
string
environmentRefList
Array of strings
object
object (Sources)
Array of objects (ServiceDependencyDTO) unique
Array of objects (NotificationRuleRefDTO)
object (TemplateDTO)
enabled
boolean
Responses
400

Bad Request

500

Internal Server Error

default

Saves monitored service data

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

Saves monitored service from template input

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.

Request Body schema: */*

Template input yaml for the monitored service creation from given template

string
Responses
400

Bad Request

500

Internal Server Error

default

Saves monitored service from template input

post/cv/api/monitored-service/template-input
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

setHealthMonitoringFlag

SecurityApiKey
Request
path Parameters
identifier
required
string
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.

enable
required
boolean
Responses
400

Bad Request

500

Internal Server Error

put/cv/api/monitored-service/{identifier}/health-monitoring-flag
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update monitored service from yaml or template

SecurityApiKey
Request
path Parameters
identifier
required
string

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: */*

Template input yaml for the monitored service creation from given template

string
Responses
400

Bad Request

500

Internal Server Error

default

Update monitored service from yaml or template

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

updateMonitoredServiceFromYaml

SecurityApiKey
Request
path Parameters
identifier
required
string
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: */*
string
Responses
400

Bad Request

500

Internal Server Error

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

Updates monitored service data

SecurityApiKey
Request
path Parameters
identifier
required
string

Identifier for the Entity.

query Parameters
accountId
required
string

Account Identifier for the Entity.

Request Body schema: */*
orgIdentifier
required
string
projectIdentifier
required
string
identifier
required
string
name
required
string
type
required
string
Enum: "Application" "Infrastructure"
description
string
serviceRef
required
string
environmentRef
string
environmentRefList
Array of strings
object
object (Sources)
Array of objects (ServiceDependencyDTO) unique
Array of objects (NotificationRuleRefDTO)
object (TemplateDTO)
enabled
boolean
Responses
400

Bad Request

500

Internal Server Error

default

Updates monitored service data

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

yamlTemplate

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.

type
string
Enum: "Application" "Infrastructure"
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/yaml-template
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}