How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harness Monitored Services API

This contains APIs related to CRUD operations of Monitored Services

Harness Monitored Services API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Monitored Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 37 operations across 34 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

37 operations 34 paths 37 schemas 1 DELETE26 GET5 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Monitored Services API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 37

Across 34 paths, the API surfaces 37 operations — 1 DELETE, 26 GET, 5 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Monitored Services 37

This contains APIs related to CRUD operations of Monitored Services

POST
/cv/api/monitored-service/create-default
Create default monitored service
createDefaultMonitoredService 5 params → 400500
GET
/cv/api/monitored-service/{identifier}
Get monitored service data
getMonitoredService 4 params → 400500default
PUT
/cv/api/monitored-service/{identifier}
Updates monitored service data
updateMonitoredService 2 params body → 400500default
DELETE
/cv/api/monitored-service/{identifier}
Delete monitored service data
deleteMonitoredService 4 params → 400500default
PUT
/cv/api/monitored-service/{identifier}/detach-template
delete template reference from monitored service
detachMonitoredServiceFromTemplate 4 params → 400500default
GET
/cv/api/monitored-service/all/time-series-health-sources
Get all monitored services with health sources
getAllMonitoredServicesWithHealthSources 3 params → 400500
GET
/cv/api/monitored-service/{identifier}/anomaliesCount
Cvget anomalies summary
CvgetAnomaliesSummary 6 params → 400500
GET
/cv/api/monitored-service/count-of-services
Get count of services
getCountOfServices 5 params → 400500
GET
/cv/api/monitored-service/environments
Get environments
getEnvironments 3 params → 400500
GET
/cv/api/monitored-service/health-sources
Get health sources
getHealthSources 5 params → 400500
GET
/cv/api/monitored-service/{monitoredServiceIdentifier}/health-sources
Get health sources for monitored service identifier
getHealthSourcesForMonitoredServiceIdentifier 4 params → 400500
GET
/cv/api/monitored-service/list
Get list
getList 8 params → 400500
GET
/cv/api/monitored-service/platform/list
Get list V2
getListV2 9 params → 400500
GET
/cv/api/monitored-service/{identifier}/secondary-events
Get MS secondary events
getMSSecondaryEvents 6 params → 400500
GET
/cv/api/monitored-service/secondary-events-details
Get MS secondary events details
getMSSecondaryEventsDetails 3 params → 400500
GET
/cv/api/monitored-service/{monitoredServiceIdentifier}/change-details
Get monitored service change details
getMonitoredServiceChangeDetails 7 params → 400500
GET
/cv/api/monitored-service/{monitoredServiceIdentifier}/service-details
Get monitored service details
getMonitoredServiceDetails 4 params → 400500
GET
/cv/api/monitored-service/service-detailsdeprecated
Get monitored service details 1
getMonitoredServiceDetails_1 5 params → 400500
GET
/cv/api/monitored-service/service-environment
Get monitored service from service and environment
getMonitoredServiceFromServiceAndEnvironment 5 params → 400500
GET
/cv/api/monitored-service/{monitoredServiceIdentifier}/logs
Get monitored service logs
getMonitoredServiceLogs 11 params → 400500
GET
/cv/api/monitored-service/reconciliation-status
fetch reconciliation status for template referenced monitored services
getMonitoredServiceReconciliationStatuses 9 params → 400500default
GET
/cv/api/monitored-service/{identifier}/resolved-template-inputs
get monitored service resolved template inputs
getMonitoredServiceResolvedTemplateInputs 6 params → 400500default
GET
/cv/api/monitored-service/{identifier}/scores
Get monitored service score
getMonitoredServiceScore 4 params → 400500
GET
/cv/api/monitored-service/{identifier}/notification-rules
Get notification rules for MonitoredService
getNotificationRulesForMonitoredService 6 params → 400500default
GET
/cv/api/monitored-service/{identifier}/overall-health-score
Get over all health score
getOverAllHealthScore 7 params → 400500
GET
/cv/api/monitored-service/services
Get services
getServices 3 params → 400500
GET
/cv/api/monitored-service/{monitoredServiceIdentifier}/health-source/{healthSourceIdentifier}/slo-metrics
Get slo metrics
getSloMetrics 5 params → 400500
GET
/cv/api/monitored-service/reconciliation-required
check if a template referenced monitored service(s) require reconciliation
isReconciliationRequiredForMonitoredServices 6 params → 400500default
GET
/cv/api/monitored-service
List
list 11 params → 400500
POST
/cv/api/monitored-service
Saves monitored service data
saveMonitoredService 1 param body → 400500default
POST
/cv/api/monitored-service/move-config/{identifier}
Move MonitoredService YAML from inline to remote
moveMonitoredServiceConfig 5 params → 400500default
POST
/cv/api/monitored-service/template-input
Saves monitored service from template input
saveMonitoredServiceFromTemplateInput 3 params body → 400500default
POST
/cv/api/monitored-service/yaml
Save monitored service from yaml
saveMonitoredServiceFromYaml 3 params body → 400500
PUT
/cv/api/monitored-service/{identifier}/health-monitoring-flag
Set health monitoring flag
setHealthMonitoringFlag 5 params → 400500
PUT
/cv/api/monitored-service/{identifier}/template-input
Update monitored service from yaml or template
updateMonitoredServiceFromTemplateInput 4 params body → 400500default
PUT
/cv/api/monitored-service/{identifier}/yaml
Update monitored service from yaml
updateMonitoredServiceFromYaml 4 params body → 400500
GET
/cv/api/monitored-service/yaml-template
Yaml template
yamlTemplate 4 params → 400500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are MonitoredService (15 properties), CvEntityGitDetails (12 properties), HealthSource (8 properties), MonitoredServiceReference (8 properties). Each schema is shown below with its type and property counts.

ChangeSourceDTO
object
6 properties 3 required
ResponseDTOString
object
4 properties
CvError
object
This is Error entity as defined in Harness
7 properties
RestResponseMonitoredServiceResponse
object
3 properties
CVNGNotificationChannelSpec
object
ValidationError
object
2 properties
TemplateDTO
object
5 properties 1 required
CvNGVariable
object
Variables that can be substituted into queries using
5 properties
MonitoredServiceResponse
object
5 properties 1 required
ServiceDependencyMetadata
object
2 properties
PageResponseNotificationRuleResponse
object
8 properties
ServiceDependencyDTO
object
3 properties
ResponseDTOPageResponseNotificationRuleResponse
object
4 properties
NotificationRuleCondition
object
2 properties 1 required
Sources
object
2 properties
QueryDefinitionsDTO
object
Query definitions specification
1 property 1 required
CvEntityGitDetails
object
This contains Git Details of the Entity
12 properties
CVNGNotificationChannel
object
2 properties 1 required
NotificationRuleResponse
object
4 properties 1 required
NotificationRule
object
This is the Notification Rule entity defined in Harness
7 properties 5 required
ResponseDTOBoolean
object
4 properties
RestResponsePageResponseMonitoredServiceReference
object
3 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
HealthSource
object
This contains details of the Health Source configuration
8 properties 5 required
PageResponseMonitoredServiceReference
object
8 properties
MonitoredService
object
This is the Monitored Service entity defined in Harness
15 properties 6 required
NotificationRuleConditionSpec
object
ResponseMessage
object
7 properties
RestResponseBoolean
object
3 properties
ResponseDTOMonitoredServiceResponse
object
4 properties
CvErrorMetadata
object
This implements different error meta data objects
1 property
QueryDefinitionsWrapper
object
Wrapper for query definitions containing type and spec
2 properties 2 required
ChangeSourceSpec
object
ResponseDTOMonitoredServiceMoveConfigResponse
object
4 properties
MonitoredServiceMoveConfigResponse
object
Tells us if the monitored service move config operation was successful or not
1 property
MonitoredServiceReference
object
8 properties
NotificationRuleRefDTO
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-monitored-services-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Monitored Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.