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

The Probes API from Harness — 8 operation(s) for probes.

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

Tagged areas include Probes. 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 11 operations across 8 paths, and defines 147 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}.

11 operations 8 paths 147 schemas 1 DELETE3 GET6 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 Probes 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 11

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

Probes 11
GET
/gateway/chaos/manager/api/rest/v2/probes
List probes with filtering options
listProbes 14 params → 200400401500
POST
/gateway/chaos/manager/api/rest/v2/probes
Create a new probe
createProbe 3 params body → 200400401500
POST
/gateway/chaos/manager/api/rest/v2/probes/experiment-run
Get probes in experiment
getProbesInExperiment 3 params body → 200400500
POST
/gateway/chaos/manager/api/rest/v2/probes/import
Import a new probe
importProbe 3 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/probes/manifest/{probeId}
Get a probe
getProbeManifest 4 params → 200400401404500
GET
/gateway/chaos/manager/api/rest/v2/probes/{probeId}
Get a probe
getProbe 4 params → 200400401404500
PUT
/gateway/chaos/manager/api/rest/v2/probes/{probeId}
Update a probe
updateProbe 4 params body → 200400401500
DELETE
/gateway/chaos/manager/api/rest/v2/probes/{probeId}
Delete a probe
deleteProbe 4 params → 200400401500
POST
/gateway/chaos/manager/api/rest/v2/probes/enable/{probeId}
Enable and disable probes across experiments
enableProbe 4 params body → 200400401500
POST
/gateway/chaos/manager/api/rest/v2/probes/verify/{probeId}
Verify a probe
verifyProbe 4 params body → 200400401500
POST
/gateway/chaos/manager/api/v3/probes/list-metadata
List probe metadata
listProbeMetadata 11 params body → 200400500

Schemas 147

The contract defines 147 schemas that model the data the API accepts and returns. The most detailed are probe.ContainerProbe (31 properties), types.GetProbeResponse (24 properties), types.CreateProbeResponse (23 properties), probe.ContainerProbeTemplate (22 properties). Each schema is shown below with its type and property counts.

github_com_harness_hce-saas_hce-sdk_template_schema_probe.DynatraceApmProbeInputs
object
3 properties
v1.WindowsSecurityContextOptions
object
3 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.NewRelicProbeInputs
object
2 properties
probe.K8SProbe
object
17 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.ENV
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.PrometheusProbeInputs
object
3 properties
common.ResourceRequirements
object
2 properties
github_com_wings-software_chaos-operator_api_litmuschaos_v1alpha1.ProbeStatus
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.NewRelicMetric
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.SplunkObservabilityProbeInputs
object
2 properties
probe.DynatraceProbeTemplate
object
5 properties
v1.SeccompProfileType
string
types.CreateProbeResponse
object
23 properties
probe.SLOProbeTemplate
object
7 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.AppDynamicsProbeInputs
object
2 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.PrometheusProbeInputs
object
3 properties
probe.ContainerProbeTemplate
object
22 properties
probe.Authorization
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.AppdMetrics
object
3 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.POST
object
6 properties
types.ProbeType
string
v1.HostPathVolumeSource
object
2 properties
types.ProbeBulkEnableRequest
object
2 properties
resource.Quantity
object
1 property
probe.PromProbeTemplate
object
6 properties
probe.LinuxCMDProbe
object
13 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.DatadogApmProbeInputs
object
4 properties
common.Volume
object
7 properties
probe.APMProbe
object
18 properties
v1.VolumeMount
object
6 properties
probe.Method
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.Headers
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.NewRelicProbeInputs
object
2 properties
probe.EvaluationWindow
object
2 properties
probe.DynatraceMetricsTemplate
object
2 properties
probe.DynatraceProbe
object
14 properties
template.InputCategory
string
template.Variable
object
13 properties 2 required
probe.SLOSourceMetadata
object
2 properties
probe.ProbeTemplateRunProperties
object
8 properties
probe.DatadogMetricsTemplate
object
3 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.POST
object
6 properties
v1.StorageMedium
string
v1.EnvVarSource
object
4 properties
types.ScenarioType
string
github_com_harness_hce-saas_hce-sdk_template_schema_probe.SecretManager
object
1 property
common.NodeAffinity
object
2 properties
probe.K8SProbeTemplate
object
8 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.GET
object
3 properties
types.ImportProbeTemplateRequest
object
9 properties 4 required
probe.AuthorizationTemplate
object
2 properties
types.ProbeRequest
object
20 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.DatadogSyntheticsTestType
string
v1.Capabilities
object
2 properties
v1.ObjectFieldSelector
object
2 properties
probe.TLSConfigTemplate
object
4 properties
common.VolumeInputTemplate
object
4 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.SecretManager
object
1 property
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.DynatraceApmProbeInputs
object
3 properties
probe.SLOProbe
object
16 properties
types.InfrastructureType
string
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.Headers
object
2 properties
v1.ResourceFieldSelector
object
3 properties
types.ProbeVerifyRequest
object
1 property
github_com_harness_hce-saas_hce-sdk_template_schema_probe.SplunkObservabilityMetrics
object
2 properties
github_com_harness_hce-saas_graphql_server_graph_model.UserDetails
object
3 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.GET
object
3 properties
probe.SyntheticsTest
object
2 properties
v1.SeccompProfile
object
2 properties
probe.ContainerProbe
object
31 properties
types.ProbeDetailsInExperiment
object
14 properties
v1.PodSecurityContext
object
10 properties
probe.HTTPProbe
object
14 properties
github_com_harness_hce-saas_graphql_server_api.Pagination
object
4 properties
probe.HttpProbeTemplate
object
5 properties
probe.ProbeTemplateProperties
object
9 properties
k8s_io_api_core_v1.EnvVar
object
3 properties
v1.ProcMountType
string
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.AppDynamicsProbeInputs
object
2 properties
probe.KubernetesCMDProbe
object
13 properties
probe.CmdProbeTemplate
object
4 properties
probe.SyntheticsTestTemplate
object
2 properties
probe.SLOSourceMetadataTemplate
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.GcpCloudMonitoringProbeInputs
object
3 properties
types.ProbeDetailsInExperimentResponse
object
1 property
github_com_wings-software_chaos-operator_api_litmuschaos_v1alpha1.ProbeVerdict
string
v1.TolerationOperator
string
probe.ComparatorTemplate
object
3 properties
v1.PullPolicy
string
types.ListProbeResponse
object
3 properties
api.RestError
object
3 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.GcpCloudMonitoringProbeInputs
object
3 properties
v1.TaintEffect
string
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.Identifier
object
3 properties
v1.PodFSGroupChangePolicy
string
types.ProbeDetailsMinimal
object
3 properties
types.Status
object
2 properties
probe.DatadogMetrics
object
3 properties
types.ListMetadataRequest
object
1 property
shared.ListMetadataResponse
object
3 properties
types.ProbeDetailsInExperimentRequest
object
2 properties
v1.SELinuxOptions
object
4 properties
api.ResponseErrorCode
string
github_com_harness_hce-saas_hce-sdk_template_schema_probe.DatadogApmProbeInputs
object
4 properties
shared.PaginationResponse
object
4 properties
github_com_harness_hce-saas_graphql_server_models_shared.Metadata
object
4 properties
v1.PersistentVolumeClaimVolumeSource
object
2 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.SplunkObservabilityProbeInputs
object
2 properties
probe.MethodTemplate
object
2 properties
probe.WindowsCMDProbe
object
12 properties
v1.Sysctl
object
2 properties
github_com_harness_hce-saas_hce-sdk_template_schema_probe.Identifier
object
3 properties
types.GetProbeResponse
object
24 properties
mongodb.ManagedBy
string
probe.Comparator
object
3 properties
v1.EmptyDirVolumeSource
object
2 properties
common.VolumeType
string
probe.TLSConfigSM
object
4 properties
probe.APMProbeType
string
probe.DatadogProbe
object
13 properties
probe.EvaluationWindowTemplate
object
2 properties
v1.ConfigMapKeySelector
object
3 properties
v1.HostPathType
string
types.ProbeRecentExecutions
object
3 properties
common.PreferredNodeSelector
object
4 properties
template.InputType
string
probe.APMTLSConfig
object
4 properties
v1.SecurityContext
object
11 properties
v1.SecretKeySelector
object
3 properties
probe.TLSConfig
object
4 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.SplunkObservabilityMetrics
object
2 properties
probe.DatadogProbeTemplate
object
4 properties
probe.Metrics
object
2 properties
probe.APMProbeTemplate
object
9 properties
types.ProbeVerdict
string
v1.Toleration
object
5 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.DatadogSyntheticsTestType
string
probe.PROMProbe
object
15 properties
mongodb.ImportType
string
github_com_harness_hce-saas_graphql_server_pkg_chaos_v2_probes_types.UserDetails
object
3 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.AppdMetrics
object
3 properties
types.Identifiers
object
3 properties
common.RequiredNodeSelector
object
3 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.ENV
object
2 properties
types.ExecutedByExperiment
object
7 properties
github_com_harness_hce-saas_graphql_server_pkg_database_mongodb_probe.NewRelicMetric
object
2 properties
v1.MountPropagationMode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-probes-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 Probes 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.