Harness

Harness Healthsources API

This contains APIs related to CV Health Sources

GitHub OpenAPI

Operations 6

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

GET /cv/api/health-sources List health sources · List Health Sources #
Ask an LLM
“Which monitoring health sources are configured in my project?”
“What metric and log sources does continuous verification pull from?”
Tell an agent
List the health sources in project {projectIdentifier}.
Show every configured health source.
PUT /cv/api/health-sources Update a health source · Update a Health Source #
Ask an LLM
“How do I change the queries a health source runs?”
“Can I point an existing health source at a different connector?”
Tell an agent
Update health source {identifier} named {name} to use connector {connectorRef} with type {dataSourceType} and queries {queryDefinitions}.
Change the query definitions of existing health source {identifier} to {queryDefinitions}.
POST /cv/api/health-sources Create a health source · Create a Health Source #
Ask an LLM
“Can I add a new metrics or logs source for deployment verification?”
“What connector and queries does a new health source need?”
Tell an agent
Create health source {name} ({identifier}) of type {dataSourceType} via connector {connectorRef} with queries {queryDefinitions}.
Add a new {dataSourceType} health source called {name} using {connectorRef}.
GET /cv/api/health-sources/{identifier} Get a health source · Get a Health Source #
Ask an LLM
“What queries and connector does a given health source use?”
“Can I see the full configuration of one health source?”
Tell an agent
Show health source {identifier}.
Get the configuration of health source {identifier} in project {projectIdentifier}.
DELETE /cv/api/health-sources/{identifier} Delete a health source · Delete a Health Source #
Ask an LLM
“Is it possible to remove a health source we no longer monitor?”
“What happens to verification when I delete its health source?”
Tell an agent destructive · confirm first
Delete health source {identifier}.
Remove health source {identifier} from project {projectIdentifier}.
GET /cv/api/health-sources/{identifier}/runtime-inputs Get runtime inputs for a health source · Get runtime inputs for a Health Source #
Ask an LLM
“Which values in a health source have to be supplied at runtime?”
“What runtime inputs does this health source expect?”
Tell an agent
List the runtime inputs of health source {identifier}.
Show what must be provided at runtime for health source {identifier}.

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-healthsources-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-healthsources-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-healthsources-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Healthsources 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:
- name: Healthsources
  description: This contains APIs related to CV Health Sources
paths:
  /cv/api/health-sources:
    get:
      tags:
      - Healthsources
      summary: List Health Sources
      operationId: listHealthSources
      parameters:
      - name: accountIdentifier
        in: query
        description: Account Identifier
        required: true
        schema:
          type: string
      - name: orgIdentifier
        in: query
        description: Organization Identifier
        schema:
          type: string
      - name: projectIdentifier
        in: query
        description: Project Identifier
        schema:
          type: string
      responses:
        default:
          description: Lists all Health Sources for the given scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDTOListHealthSourceResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ResponseDTOListHealthSourceResponse'
    put:
      tags:
      - Healthsources
      summary: Update a Health Source
      operationId: updateHealthSource
      parameters:
      - name: accountIdentifier
        in: query
        description: Account Identifier
        required: true
        schema:
          type: string
      - name: orgIdentifier
        in: query
        description: Organization Identifier
        schema:
          type: string
      - name: projectIdentifier
        in: query
        description: Project Identifier
        schema:
          type: string
      requestBody:
        description: Health Source configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthSource'
          application/yaml:
            schema:
              $ref: '#/components/schemas/HealthSource'
        required: true
      responses:
        default:
          description: Updates an existing Health Source configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDTOHealthSourceResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ResponseDTOHealthSourceResponse'
    post:
      tags:
      - Healthsources
      summary: Create a Health Source
      operationId: createHealthSource
      parameters:
      - name: accountIdentifier
        in: query
        description: Account Identifier
        required: true
        schema:
          type: string
      - name: orgIdentifier
        in: query
        description: Organization Identifier
        schema:
          type: string
      - name: projectIdentifier
        in: query
        description: Project Identifier
        schema:
          type: string
      requestBody:
        description: Health Source configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthSource'
          application/yaml:
            schema:
              $ref: '#/components/schemas/HealthSource'
        required: true
      responses:
        default:
          description: Creates a new Health Source for verifying metrics or logs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDTOHealthSourceResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ResponseDTOHealthSourceResponse'
  /cv/api/health-sources/{identifier}:
    get:
      tags:
      - Healthsources
      summary: Get a Health Source
      operationId: getHealthSource
      parameters:
      - name: accountIdentifier
        in: query
        description: Account Identifier
        required: true
        schema:
          type: string
      - name: orgIdentifier
        in: query
        description: Organization Identifier
        schema:
          type: string
      - name: projectIdentifier
        in: query
        description: Project Identifier
        schema:
          type: string
      - name: identifier
        in: path
        description: Health Source Identifier
        required: true
        schema:
          type: string
      responses:
        default:
          description: Retrieves a Health Source by its identifier
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDTOOptionalHealthSourceResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ResponseDTOOptionalHealthSourceResponse'
    delete:
      tags:
      - Healthsources
      summary: Delete a Health Source
      operationId: deleteHealthSource
      parameters:
      - name: accountIdentifier
        in: query
        description: Account Identifier
        required: true
        schema:
          type: string
      - name: orgIdentifier
        in: query
        description: Organization Identifier
        schema:
          type: string
      - name: projectIdentifier
        in: query
        description: Project Identifier
        schema:
          type: string
      - name: identifier
        in: path
        description: Health Source Identifier
        required: true
        schema:
          type: string
      responses:
        default:
          description: Deletes a Health Source by its identifier
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDTOBoolean'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ResponseDTOBoolean'
  /cv/api/health-sources/{identifier}/runtime-inputs:
    get:
      tags:
      - Healthsources
      summary: Get runtime inputs for a Health Source
      operationId: getHealthSourceRuntimeInputs
      parameters:
      - name: accountIdentifier
        in: query
        description: Account Identifier
        required: true
        schema:
          type: string
      - name: orgIdentifier
        in: query
        description: Organization Identifier
        schema:
          type: string
      - name: projectIdentifier
        in: query
        description: Project Identifier
        schema:
          type: string
      - name: identifier
        in: path
        description: Health Source Identifier
        required: true
        schema:
          type: string
      responses:
        default:
          description: Returns only the fields marked as <+input> on the saved HealthSource. Embed runtimeInputYaml directly as healthSourceInputs in the AI Verify step YAML.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDTOHealthSourceRuntimeInputs'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ResponseDTOHealthSourceRuntimeInputs'
components:
  schemas:
    CvNGVariable:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
          enum:
          - String
          - Number
          - Secret
        description:
          type: string
        required:
          type: boolean
        metadata:
          type: string
      description: Variables that can be substituted into queries using <+healthSourceVariables.name>
      discriminator:
        propertyName: type
    HealthSourceResponse:
      type: object
      properties:
        accountId:
          type: string
          description: Account identifier
        orgIdentifier:
          type: string
          description: Organization identifier
        projectIdentifier:
          type: string
          description: Project identifier
        identifier:
          type: string
          description: Identifier of the Health Source
        name:
          type: string
          description: Name of the Health Source
        connectorRef:
          type: string
          description: Connector reference for the data source
        mcpRef:
          type: string
          description: MCP reference for AI/ML capabilities
        dataSourceType:
          type: string
          description: Type of data source
          enum:
          - DatadogMetrics
          - DynatraceGrailLogs
          - DynatraceGrailMetrics
          - PrometheusMetrics
        queryDefinitions:
          $ref: '#/components/schemas/QueryDefinitionsWrapper'
        healthSourceParams:
          type: object
          additionalProperties:
            type: string
            description: Additional parameters for the health source
          description: Additional parameters for the health source
        variables:
          type: array
          description: Variables that can be substituted into queries using <+healthSourceVariables.name>
          items:
            $ref: '#/components/schemas/CvNGVariable'
        createdAt:
          type: integer
          description: Creation timestamp
          format: int64
        lastUpdatedAt:
          type: integer
          description: Last updated timestamp
          format: int64
      description: Response containing Health Source details
    HealthSourceRuntimeInputs:
      type: object
      properties:
        hasRuntimeInputs:
          type: boolean
          description: True when the HealthSource has at least one <+input> field
        runtimeInputYaml:
          type: string
          description: 'YAML snippet to embed directly as healthSourceInputs: in the AI Verify step YAML. Null when hasRuntimeInputs is false.'
        runtimeInputs:
          $ref: '#/components/schemas/CvJsonNode'
      description: Fields on the HealthSource that require runtime input values (<+input> marked). Embed runtimeInputYaml directly as healthSourceInputs in the AI Verify step.
    ResponseDTOHealthSourceRuntimeInputs:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - ERROR
        data:
          $ref: '#/components/schemas/HealthSourceRuntimeInputs'
        metaData:
          type: object
        correlationId:
          type: string
    ResponseDTOListHealthSourceResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - ERROR
        data:
          type: array
          items:
            $ref: '#/components/schemas/HealthSourceResponse'
        metaData:
          type: object
        correlationId:
          type: string
    ResponseDTOBoolean:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - ERROR
        data:
          type: boolean
        metaData:
          type: object
        correlationId:
          type: string
    HealthSource:
      required:
      - connectorRef
      - dataSourceType
      - identifier
      - name
      - queryDefinitions
      type: object
      properties:
        identifier:
          type: string
          description: Identifier of the Health Source
        name:
          type: string
          description: Name of the Health Source
        connectorRef:
          type: string
          description: Connector reference for the data source
        mcpRef:
          type: string
          description: MCP reference for AI/ML capabilities
        dataSourceType:
          type: string
          description: Type of data source
          enum:
          - DatadogMetrics
          - DynatraceGrailLogs
          - DynatraceGrailMetrics
          - PrometheusMetrics
        queryDefinitions:
          $ref: '#/components/schemas/QueryDefinitionsWrapper'
        healthSourceParams:
          type: object
          additionalProperties:
            type: string
            description: Additional parameters for the health source
          description: Additional parameters for the health source
        variables:
          type: array
          description: Variables that can be substituted into queries using <+healthSourceVariables.name>
          items:
            $ref: '#/components/schemas/CvNGVariable'
      description: This contains details of the Health Source configuration
    QueryDefinitionsDTO:
      required:
      - type
      type: object
      properties:
        type:
          type: string
      description: Query definitions specification
      discriminator:
        propertyName: type
    ResponseDTOHealthSourceResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - ERROR
        data:
          $ref: '#/components/schemas/HealthSourceResponse'
        metaData:
          type: object
        correlationId:
          type: string
    CvJsonNode:
      type: object
      description: Same data in JSON form for typed UI rendering. Null when hasRuntimeInputs is false.
    ResponseDTOOptionalHealthSourceResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          - ERROR
        data:
          $ref: '#/components/schemas/HealthSourceResponse'
        metaData:
          type: object
        correlationId:
          type: string
    QueryDefinitionsWrapper:
      required:
      - spec
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of verification - METRICS or LOGS
          enum:
          - Metrics
          - Logs
        spec:
          $ref: '#/components/schemas/QueryDefinitionsDTO'
      description: Wrapper for query definitions containing type and spec
  securitySchemes:
    x-api-key:
      name: x-api-key
      type: apiKey
      in: header
      description: API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
x-stoplight:
  id: oc91t4vrfnjyi
x-tagGroups:
- name: Organizations
  tags:
  - Organization
- name: Projects
  tags:
  - Org Project
  - Project
- name: Secrets
  tags:
  - Account Secret
  - Org Secret
  - Project Secret
  - Secrets
- name: Connectors
  tags:
  - Account Connector
  - Org Connector
  - Project Connector
  - Connectors
  - GoogleSecretManagerConnector
- name: Roles
  tags:
  - Account Roles
  - Organization Roles
  - Project Roles
  - Roles
- name: Resource Groups
  tags:
  - Account Resource Groups
  - Organization Resource Groups
  - Project Resource Groups
  - Filter Resource Groups
  - Harness Resource Group
  - Zendesk
- name: Role Assignments
  tags:
  - Account Role Assignments
  - Org Role Assignments
  - Project Role Assignments
  - Role Assignments
- name: Platform
  tags:
  - Access Control List
  - Account Banner
  - Account Banner
  - Account Licensed Modules
  - Account License Type
  - Account Webhooks
  - AccountSetting
  - Accounts
  - Analyze Account Access Policy
  - Analyze Organization Access Policy
  - Analyze Project Access Policy
  - ApiKey
  - Audit
  - AuditFilters
  - Authentication Settings
  - Canny
  - Devops Essentials License Data By Account
  - EULA
  - Filter
  - Harness Resource Type
  - Invite
  - IP Allowlist
  - Nextgen Ldap
  - Notification Channels
  - Notification Rules
  - OIDC
  - Oidc-Access-Token
  - Oidc-ID-Token
  - Org Webhooks
  - Permissions
  - Project Webhooks
  - Secret Managers
  - Service Account
  - Setting
  - SMTP
  - Source Code Manager
  - Token
  - User
  - User Group
  - Variables
- name: Delegate
  tags:
  - Agent mTLS Endpoint Management
  - Delegate Download Resource
  - Delegate Group Tags Resource
  - Delegate Setup Resource
  - Delegate Token Resource
- name: Pipelines
  tags:
  - Pipelines
  - Input Sets
  - Approvals
  - Pipeline Execution
  - Pipeline Dashboard
  - Pipeline Input Set
  - Pipeline
  - Pipeline Execution Details
  - Pipeline Execute
  - Pipeline Refresh
  - Pipeline data retention
  - Triggers
  - TriggersEvents
  - Webhook Triggers
  - Webhook Event Handler
  - DryRunPipeline
- name: Artifact Registry
  tags:
  - Registries
  - Artifacts
  - Docker Artifacts
  - Helm Artifacts
  - quarantine
  - Webhooks
  - Spaces
  - Replication
  - Registry V3 - Registries
  - Registry V3 - Packages
  - Registry V3 - Versions
  - Registry V3 - Files
  - Registry V3 - Metadata
  - Registry V3 - Firewall
  - Registry V3 - Transfer
- name: Database DevOps
  tags:
  - Database Schema
  - Database Instance
  - Deployed State
  - Execution Config
  - Migration State
- name: CD
  tags:
  - K8s Release Service Mapping
  - CustomDeployment
  - Environments
  - EnvironmentGroup
  - Infrastructures
  - Usage
  - File Store
  - Service Dashboard
  - ServiceOverrides
  - Rollback
  - tas
- name: Deployment Freeze
  tags:
  - Freeze CRUD
  - Freeze Evaluation
  - Freeze Schema
- name: Services
  tags:
  - Account Services
  - Org Services
  - Project Services
  - Services
- name: Rancher Infrastructures
  tags:
  - Account Rancher Infrastructure
  - Org Rancher Infrastructure
  - Project Rancher Infrastructure
- name: Templates
  tags:
  - Account Template
  - Org Template
  - Project Template
  - Templates
  - Global Templates
- name: GitOps
  tags:
  - Agents
  - Application
  - Applications
  - Certificates
  - Clusters
  - Dashboard Aggregates
  - Dashboards
  - GnuPGP Keys
  - GPG Keys
  - Hosts
  - Project mappings
  - Projects
  - Reconciler
  - Repositories
  - Repository Certificates
  - Repository credentials
  - ValidateHost
- name: GitX
  tags:
  - GitX Webhooks
  - Org Gitx Webhooks
  - Project Gitx Webhooks
- name: CACM
  tags:
  - Anomalies Ignorelist Rule
  - Anomalies
  - BI Dashboards
  - Budgets
  - Budget Groups
  - Cost Categories
  - Cloud Accounts
  - K8S Connectors Metadata
  - Notification Settings v2
  - Overview
  - Data Job Status
  - Recommendation cost settings
  - Unit Metric
  - Anomaly Comments
  - Cloud and AI cost anomaly details
  - Cloud and AI cost anomalies v2
  - Cost Details
  - Currency Preferences
  - External Data Provider
  - AiEngine
  - CACM governance cost settings
  - Governance Enforcement Recommendation APIs
  - Governance Alert
  - Governance Overview
  - Governance Recommendation APIs
  - RuleEnforcement
  - Rule Executions
  - Rule
  - Rule Sets
  - Perspectives Folders
  - Perspective Reports
  - Perspectives
  - Cost Category Jira Project Mapping
  - Recommendations Details
  - Recommendations
  - Recommendation Jira
  - Recommendation Preferences
  - Recommendation Presets
  - Recommendation Servicenow
  - Recommendation Tags
  - Recommendation Ignore List
  - AutoStopping Rules
  - AutoStopping Rules V2
  - AutoStopping Load Balancers
  - AutoStopping Fixed Schedules
  - AutoStopping Alerts
  - Commitment Orchestrator Events APIs
- name: Feature Flags
  tags:
  - API Keys
  - Feature Flags
  - Targets
  - Target Groups
  - Environment Perspectives
  - Anomalies
  - Proxy
  - Tags
- name: SRM
  tags:
  - Monitored Services
  - SLOs dashboard
  - NG SLOs
  - SLOs
  - Downtime
  - Srm Notification
- name: Internal Developer Portal - IDP
  tags:
  - Entities
  - Teams
  - CatalogCustomProperties
  - Scores
  - DataSource
  - KubernetesDataPoints
  - AggregationRules
  - AppConfig
  - PluginInfo
  - LayoutProxy
  - Kinds
  - LayoutsV3
  - LayoutsV4
- name: Environment Management - IDP
  tags:
  - Environment
  - Infrastructure
  - Instance
- name: Custom Dashboards
  tags:
  - aida
  - dashboards
  - downloads
  - embed
  - folders
- name: Policy Management
  tags:
  - dashboard
  - examples
  - policies
  - evaluate
  - evaluations
  - policysets
  - system
- name: Code
  tags:
  - repository
  - status_checks
  - pullreq
  - upload
  - webhook
  - resource
  - rules
  - labels
- name: IaCM
  tags:
  - usage
  - approvals
  - costs
  - executions
  - module-registry
  - workspaces
  - settings
  - tf-standard-backend
  - variables
- name: STO
  tags:
  - Exemptions
  - Issues
  - Scans
  - Products
  - Test Targets
  - Target Variants
- name: SEI
  tags:
  - Collection categories
  - Collections
  - Contributors
  - DORA
- name: Git Sync (deprecated)
  tags:
  - Git Branches
  - Git Full Sync
  - Git Sync Settings
  - Git Sync
  - Git Sync Errors
- name: Error Models
  tags:
  - Error Response
  - Governance Metadata
- name: Supply Chain Security
  tags:
  - integration
  - PipelineInfraConfig
  - SBOM
  - Integration Step Config
  - Delete Step Config
  - Delete Repositories
  - Pipeline Store Config
  - Evidence Vault [Beta]
- name: Release Management
  tags:
  - Release Groups
  - Releases
  - Orchestration Processes
  - Orchestration Activities
  - Orchestration Executions
  - Conflicts
  - Freeze
  - Reports
  - Uploads
- name: Resilience Testing
  tags:
  - Actions
  - Action Templates
  - Chaos Components
  - Chaos Hubs
  - ChaosGuard Conditions
  - ChaosGuard Rules
  - DR Tests
  - Experiments
  - Experiment Templates
  - Faults
  - Fault Templates
  - Chaos Infrastructure
  - Health
  - Network Maps
  - Onboarding
  - Probes
  - Probe Templates
  - Chaos Recommendations
  - Risks