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 Checks API

The Checks API from Harness — 4 operation(s) for checks.

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

Tagged areas include Checks. 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 7 operations across 4 paths, and defines 12 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}.

7 operations 4 paths 12 schemas 1 DELETE4 GET1 POST1 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 Checks 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 7

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

Checks 7
GET
/v1/checks
Get all checks available
get-checks 6 params → 200
POST
/v1/checks
Create a custom check
create-check 1 param body → 201
GET
/v1/checks/{check-id}
Get check details for given checkId
get-check 3 params → 200
PUT
/v1/checks/{check-id}
Update check details for given checkId
update-check 2 params body → 200
DELETE
/v1/checks/{check-id}
Delete check details for given checkId
delete-check 3 params → 204
GET
/v1/checks/{check-id}/stats
Get check stats for given checkId
get-check-stats 3 params → 200
GET
/v1/checks/{check-id}/graph
Get check graph data for given checkId
get-check-graph 3 params → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are CheckStats (7 properties), Check (6 properties), Rule (6 properties), CheckStatsResponse (3 properties). Each schema is shown below with its type and property counts.

Rule
object
6 properties 4 required
InputValue
object
2 properties 2 required
CheckStatsResponse
object
CheckStatsResponse
3 properties 2 required
Check
object
Check
6 properties 3 required
CheckResponse
object
1 property
CheckDetailsRequest
object
1 property
CheckGraph
object
2 properties
CheckDetailsResponse
object
1 property 1 required
CheckDetails
DefaultSaveResponse
object
Default response for Save/Edit operations
1 property 1 required
CheckListItem
CheckListItem
CheckStats
object
CheckStats
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-checks-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 Checks 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.