Harness

Harness Monitored Services API

This contains APIs related to CRUD operations of Monitored Services

GitHub OpenAPI

Operations 37

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /cv/api/monitored-service/create-default Create a default monitored service · Create default monitored service #
Ask an LLM
“Can Harness spin up a default monitored service for a service and environment pair automatically?”
“What is the quickest way to start monitoring a service without writing a full health source config?”
Tell an agent
Create a default monitored service for service {service} in environment {environment}.
Set up the default monitored service for {service} in {environment} under project {project}.
GET /cv/api/monitored-service/{identifier} Get a monitored service's configuration · Get monitored service data #
Ask an LLM
“How do I see the full configuration of one monitored service, including its health sources and dependencies?”
“Where can I read back the definition of a monitored service I already saved?”
Tell an agent
Show me the configuration of monitored service {identifier}.
Fetch monitored service {identifier} from project {project}.
PUT /cv/api/monitored-service/{identifier} Update a monitored service's settings · Updates monitored service data #
Ask an LLM
“Can I rename a monitored service or change its tags and notification rules after it exists?”
“How do I change which service or environment an existing monitored service points at?”
Tell an agent
Rename monitored service {identifier} to {name}.
Update the description of monitored service {identifier} to {description}.
DELETE /cv/api/monitored-service/{identifier} Delete a monitored service · Delete monitored service data #
Ask an LLM
“How do I remove a monitored service I no longer need?”
“Does deleting a monitored service stop its service reliability tracking entirely?”
Tell an agent destructive · confirm first
Delete monitored service {identifier}.
Remove monitored service {identifier} from project {project}.
PUT /cv/api/monitored-service/{identifier}/detach-template Detach a monitored service from its template · delete template reference from monitored service #
Ask an LLM
“Can I unlink a monitored service from the template it was created from so I can edit it freely?”
“How do I stop a monitored service from following template changes?”
Tell an agent
Detach monitored service {identifier} from its template.
Remove the template reference from monitored service {identifier}.
GET /cv/api/monitored-service/all/time-series-health-sources List monitored services with time-series health sources · Get all monitored services with health sources #
Ask an LLM
“Which monitored services in my project have time-series health sources attached?”
“Can I get every monitored service along with its metric health sources in one call?”
Tell an agent
List all monitored services with time-series health sources in project {project}.
Show which monitored services in org {org} have metric health sources.
GET /cv/api/monitored-service/{identifier}/anomaliesCount Count anomalies for a monitored service · Cvget anomalies summary #
Ask an LLM
“How many anomalies did a monitored service record over a given time window?”
“Can I get an anomaly count summary for one monitored service between two timestamps?”
Tell an agent
Count the anomalies on monitored service {identifier} between {start} and {end}.
Summarize anomaly counts for monitored service {identifier} since {start}.
GET /cv/api/monitored-service/count-of-services Count monitored services in a project · Get count of services #
Ask an LLM
“How many monitored services does my project have in total?”
“Can I count monitored services for just one environment?”
Tell an agent
Count the monitored services in project {project}.
Tell me how many monitored services exist in environment {environment}.
GET /cv/api/monitored-service/environments List environments that have monitored services · Get environments #
Ask an LLM
“Which environments currently have monitored services configured?”
“What environments show up in service reliability monitoring for my project?”
Tell an agent
List the environments with monitored services in project {project}.
Show environments used by monitored services in org {org}.
GET /cv/api/monitored-service/health-sources Get health sources for a service and environment · Get health sources #
Ask an LLM
“What health sources feed monitoring for a given service in a given environment?”
“Can I look up health sources by service and environment instead of by monitored service ID?”
Tell an agent
List health sources for service {service} in environment {environment}.
Show the metric and log sources monitoring {service} in {environment}.
GET /cv/api/monitored-service/{monitoredServiceIdentifier}/health-sources List health sources of a monitored service · Get health sources for monitored service identifier #
Ask an LLM
“Which health sources are attached to a specific monitored service?”
“Can I see the data sources behind one monitored service by its identifier?”
Tell an agent
List the health sources attached to monitored service {monitoredService}.
Show what feeds data into monitored service {monitoredService}.
GET /cv/api/monitored-service/list Page through monitored services by environment · Get list #
Ask an LLM
“Can I page through monitored services and narrow them to one or more environments?”
“What paginated view of monitored services is available with a text filter?”
Tell an agent
Page through monitored services in environment {environment}, {size} per page.
Get page {offset} of monitored services matching {filter}.
GET /cv/api/monitored-service/platform/list List monitored services on the platform list view · Get list V2 #
Ask an LLM
“Can I hide monitored services that are not configured yet when listing them?”
“How do I list monitored services filtered by monitored service type on the platform view?”
Tell an agent
List platform monitored services of type {type}, hiding unconfigured ones: {hide}.
Show the platform list of monitored services in project {project}, page size {size}.
GET /cv/api/monitored-service/{identifier}/secondary-events Get secondary events on a monitored service · Get MS secondary events #
Ask an LLM
“What secondary events like downtime or annotations hit a monitored service in a time range?”
“Can I pull the secondary event timeline for one monitored service?”
Tell an agent
List secondary events on monitored service {identifier} between {start} and {end}.
Show the secondary event timeline for monitored service {identifier}.
GET /cv/api/monitored-service/secondary-events-details Get details of secondary events · Get MS secondary events details #
Ask an LLM
“How do I get the full details for specific secondary events by their IDs?”
“Can I expand a secondary event of a given type to see what happened?”
Tell an agent
Get details for secondary events {ids} of type {type}.
Expand secondary event {ids} so I can see its details.
GET /cv/api/monitored-service/{monitoredServiceIdentifier}/change-details Get change details for a monitored service · Get monitored service change details #
Ask an LLM
“What changes affected a monitored service, and which SLOs did they touch?”
“Can I see change details for a monitored service scoped to certain SLOs?”
Tell an agent
Show change details for monitored service {monitoredService}.
Get the changes on monitored service {monitoredService} affecting SLOs {slos}.
GET /cv/api/monitored-service/{monitoredServiceIdentifier}/service-details Get service details by monitored service ID · Get monitored service details #
Ask an LLM
“How do I fetch the service and environment details behind a monitored service identifier?”
“What service details does a given monitored service resolve to?”
Tell an agent
Get service details for monitored service {monitoredService}.
Look up which service and environment monitored service {monitoredService} covers.
GET /cv/api/monitored-service/service-details Get monitored service details by service and environment · Get monitored service details 1 #
Ask an LLM
“Can I get monitored service details knowing only the service and environment identifiers?”
“What monitored service details exist for a service in a specific environment?”
Tell an agent
Get monitored service details for service {service} and environment {environment}.
Pull service details via service {service} in environment {environment}, not by monitored service ID.
GET /cv/api/monitored-service/service-environment Find the monitored service for a service and environment · Get monitored service from service and environment #
Ask an LLM
“Which monitored service is tracking my service in production?”
“Is there already a monitored service for this service and environment combination?”
Tell an agent
Find the monitored service for service {service} in environment {environment}.
Check whether {service} in {environment} already has a monitored service.
GET /cv/api/monitored-service/{monitoredServiceIdentifier}/logs Get verification logs for a monitored service · Get monitored service logs #
Ask an LLM
“How do I see API call or execution logs for a monitored service over a time window?”
“Can I filter a monitored service's logs to errors only?”
Tell an agent
Show {logType} logs for monitored service {monitoredService} between {start} and {end}.
Get only error logs of type {logType} for monitored service {monitoredService}.
GET /cv/api/monitored-service/reconciliation-status Get reconciliation status for template-based services · fetch reconciliation status for template referenced monitored services #
Ask an LLM
“Which monitored services built from a template are out of sync with a template version?”
“Can I see reconciliation status for every monitored service using a given template?”
Tell an agent
Show reconciliation status for monitored services using template {template} version {version}.
List the sync state of services built from template {template} at {version}.
GET /cv/api/monitored-service/{identifier}/resolved-template-inputs Get resolved template inputs for a monitored service · get monitored service resolved template inputs #
Ask an LLM
“What values did a template-based monitored service resolve its inputs to?”
“Can I see the final template inputs a monitored service is using?”
Tell an agent
Get resolved template inputs for monitored service {identifier} from template {template} version {version}.
Show which input values monitored service {identifier} resolved from its template.
GET /cv/api/monitored-service/{identifier}/scores Get health and SLO scores for a monitored service · Get monitored service score #
Ask an LLM
“What are the current health and SLO scores for a monitored service?”
“How healthy is one of my monitored services right now?”
Tell an agent
Get the scores for monitored service {identifier}.
Show the current score card of monitored service {identifier} in project {project}.
GET /cv/api/monitored-service/{identifier}/notification-rules List notification rules on a monitored service · Get notification rules for MonitoredService #
Ask an LLM
“Which notification rules are wired to a monitored service?”
“Who gets alerted when a monitored service changes health?”
Tell an agent
List the notification rules for monitored service {identifier}.
Show page {page} of alert rules on monitored service {identifier}.
GET /cv/api/monitored-service/{identifier}/overall-health-score Get a monitored service's overall health score · Get over all health score #
Ask an LLM
“How has a monitored service's overall health score trended over the last day?”
“Can I pull the overall health score over a set duration ending at a timestamp?”
Tell an agent
Get the overall health score of monitored service {identifier} ending at {end}.
Show the overall health trend for {identifier} over duration {duration} up to {end}.
GET /cv/api/monitored-service/services List services that have monitored services · Get services #
Ask an LLM
“Which services in my project are being monitored?”
“What services appear in service reliability monitoring for a project?”
Tell an agent
List the monitored services' underlying services in project {project}.
Show which services are covered by monitoring in org {org}.
GET /cv/api/monitored-service/{monitoredServiceIdentifier}/health-source/{healthSourceIdentifier}/slo-metrics List SLO metrics from a health source · Get slo metrics #
Ask an LLM
“Which metrics from a health source can I use to define an SLO?”
“What SLO-eligible metrics does a monitored service's health source expose?”
Tell an agent
List SLO metrics from health source {healthSource} on monitored service {monitoredService}.
Show metrics I can build an SLO on from {healthSource} in {monitoredService}.
GET /cv/api/monitored-service/reconciliation-required Check if template-based services need reconciliation · check if a template referenced monitored service(s) require reconciliation #
Ask an LLM
“Do any monitored services need reconciling after I changed their template?”
“Is a yes/no reconciliation check available for services tied to a template version?”
Tell an agent
Check whether services using template {template} version {version} need reconciliation.
Tell me if monitored service {monitoredService} must be reconciled with template {template} {version}.
GET /cv/api/monitored-service List monitored services with at-risk filter · List #
Ask an LLM
“Which monitored services are currently at risk?”
“Can I list monitored services for a single service across environments?”
Tell an agent
List monitored services at risk only: {atRisk}, {size} per page.
Show all monitored services for service {service}, page offset {offset}.
POST /cv/api/monitored-service Create a monitored service · Saves monitored service data #
Ask an LLM
“How do I create a monitored service with my own health sources and dependencies?”
“What do I need to supply to register a new monitored service for a service?”
Tell an agent
Create monitored service {name} with identifier {identifier} for service {serviceRef}.
Save a new {type} monitored service {identifier} for {serviceRef} in environment {environmentRef}.
POST /cv/api/monitored-service/move-config/{identifier} Move a monitored service YAML to Git · Move MonitoredService YAML from inline to remote #
Ask an LLM
“Can I move a monitored service's YAML from inline storage into a remote Git repo?”
“How do I convert an inline monitored service to a remote one?”
Tell an agent
Move monitored service {identifier} from inline to remote using move type {moveType}.
Store the YAML for monitored service {identifier} remotely in Git.
POST /cv/api/monitored-service/template-input Create a monitored service from template inputs · Saves monitored service from template input #
Ask an LLM
“Can I create a monitored service by filling in a template's inputs?”
“How do I save a new monitored service from a monitored service template?”
Tell an agent
Create a monitored service from template inputs in project {project}.
Save a template-based monitored service in org {org} project {project}.
POST /cv/api/monitored-service/yaml Create a monitored service from YAML · Save monitored service from yaml #
Ask an LLM
“Can I create a monitored service by posting its YAML definition?”
“Is there a YAML-first way to register a new monitored service?”
Tell an agent
Create a monitored service from this YAML in project {project}.
Import a new monitored service YAML definition into org {org}.
PUT /cv/api/monitored-service/{identifier}/health-monitoring-flag Turn health monitoring on or off · Set health monitoring flag #
Ask an LLM
“How do I pause health monitoring for a monitored service without deleting it?”
“Can I re-enable health monitoring on a service I paused?”
Tell an agent
Set health monitoring on monitored service {identifier} to {enable}.
Pause health monitoring for monitored service {identifier}.
PUT /cv/api/monitored-service/{identifier}/template-input Update a monitored service from template inputs · Update monitored service from yaml or template #
Ask an LLM
“Can I update an existing monitored service by re-supplying its template inputs?”
“How do I refresh a template-based monitored service with new input values?”
Tell an agent
Update monitored service {identifier} from new template inputs.
Reapply template inputs to existing monitored service {identifier}.
PUT /cv/api/monitored-service/{identifier}/yaml Update a monitored service from YAML · Update monitored service from yaml #
Ask an LLM
“Can I overwrite an existing monitored service by sending updated YAML?”
“How do I edit a monitored service's YAML definition in place?”
Tell an agent
Update monitored service {identifier} using this YAML.
Replace the YAML definition of existing monitored service {identifier}.
GET /cv/api/monitored-service/yaml-template Get a starter YAML for a monitored service · Yaml template #
Ask an LLM
“Where can I get a starter YAML skeleton for a new monitored service?”
“Is there a sample monitored service YAML for a given type?”
Tell an agent
Give me the monitored service YAML template for type {type}.
Generate a blank monitored service YAML for project {project}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/authentication/harness-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-monitored-services-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/errors/harness-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-monitored-services-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harness-monitored-services-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Monitored Services API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:


# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-monitored-services-api-openapi.yml