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

The Experiments API from Harness — 28 operation(s) for experiments.

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

Tagged areas include Experiments. 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 34 operations across 28 paths, and defines 290 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}.

34 operations 28 paths 290 schemas 2 DELETE17 GET1 PATCH13 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 Experiments 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 34

Across 28 paths, the API surfaces 34 operations — 2 DELETE, 17 GET, 1 PATCH, 13 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Experiments 34
GET
/gateway/chaos/manager/api/rest/chaos-experiment-run/report/{experimentRunId}/{notifyId}
Generate and return kubernetesV1 chaos experiment run report
GetChaosExperimentRunReport 5 params → 200400500
GET
/gateway/chaos/manager/api/rest/overview/experiment-stats
Get chaos experiment run overview stats
getExperimentRunsOverviewStats 6 params → 200400404500
POST
/gateway/chaos/manager/api/rest/v2/bulkaction/bulkexperimentdelete
Delete given experiments
bulkExperimentDelete 3 params body → 200400500
POST
/gateway/chaos/manager/api/rest/v2/bulkaction/bulkexperimenttagsadd
Add tags in given experiments
bulkExperimentTagAdd 3 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/chaos-pipeline/step/{experimentId}/{experimentRunId}/{stepName}
Get a chaos pipeline step execution
getChaosPipelineStepDetails 6 params → 200400500
GET
/gateway/chaos/manager/api/rest/v2/chaos-pipeline/{experimentId}
Get a chaos pipeline execution
getChaosPipelineExecution 6 params → 200400500
GET
/gateway/chaos/manager/api/rest/v2/experiment
List chaos v2 experiments
listChaosV2Experiment 16 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiment
Save a chaos v2 experiment
saveChaosV2Experiment 3 params body → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiment-runs/csv
Download experiment runs as CSV
getExperimentRunsCSV 9 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiment/bulk/run
Create pipeline to run experiments in bulk
createChaosExperimentPipeline 3 params body → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiment/cron
Update a chaos v2 cron experiment
updateChaosV2CronExperiment 3 params body → 200400500
DELETE
/gateway/chaos/manager/api/rest/v2/experiment/{experimentId}
Delete a chaos v2 experiment
deleteChaosV2Experiment 4 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiment/{experimentId}/stop
Stop a chaos v2 experiment
stopChaosV2Experiment 7 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiments
List experiments
listExperiments 6 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/experiments/timeline/run/{experimentId}
Get a chaos v2 experiment timeline run
getExperimentRunTimelineView 6 params → 200400500
GET
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}
Get a chaos v2 experiment
getChaosV2Experiment 4 params → 200400500
GET
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets
Get the list of input sets in an experiment
listInputSet1 7 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets
Create an input set
createInputSet 5 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId}
Get the input set in an experiment
getInputSet1 6 params → 200400500
PUT
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId}
Update an input set
updateInputSet 6 params body → 200400500
DELETE
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId}
Delete an input set
deleteInputSet1 6 params → 200400500
GET
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/run
Get a chaos v2 experiment run
getChaosV2ExperimentRun 6 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/run
Run a chaos v2 experiment
runChaosV2Experiment 6 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/variables
Get a chaos v2 experiment
getChaosV2ExperimentVariables 5 params → 200400500
PATCH
/gateway/chaos/manager/api/rest/v2/note
Update a resource note
updateNote 3 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/notes
Get a chaos resource Note
getNote 7 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/notes
Add a resource note
addNote 3 params body → 200400500
POST
/gateway/chaos/manager/api/rest/v2/pipeline/experiment/runs
List the experiment runs for a pipeline execution
getChaosExperimentRunsForPipeline 3 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/pipeline/verify/runs
Verify the chaos stage in pipeline run
verifyChaosStageInPipelineRun 6 params → 200400500
GET
/gateway/chaos/manager/api/v1/notification-experiments
List chaos experiments with active infrastructures in minimal format for…
listExperimentsWithActiveInfrasMinimalNotification 6 params → 200400404500
GET
/gateway/chaos/manager/api/v3/chaos-experiment-run/report/{experimentId}/{chaosExperimentRunId}
Generate and return beta1 chaos experiment run report
GetChaosExperimentRunReportPDF 6 params → 200400500
POST
/gateway/chaos/manager/api/v3/experiments/list-metadata
List experiment metadata
listExperimentMetadata 11 params body → 200400500
GET
/gateway/chaos/manager/api/v3/integrations/get-experiment-or-template-variable
Get experiment or template inputs
getExperimentOrTemplateVariable 8 params → 200400500
GET
/gateway/chaos/manager/api/v3/integrations/list-experiment-or-template
List experiment or template metadata
listExperimentOrTemplate 15 params → 200400500

Schemas 290

The contract defines 290 schemas that model the data the API accepts and returns. The most detailed are chaos_experiment_run.ChaosExperimentRun (39 properties), v1.Volume (30 properties), chaos_experiment.ChaosExperimentRequest (29 properties), types.ExperimentV2 (26 properties). Each schema is shown below with its type and property counts.

v1.WindowsSecurityContextOptions
object
3 properties
experiment.Auth
object
9 properties
v1.Volume
object
30 properties
v1.APMProbeInputs
object
9 properties
common.ResourceRequirements
object
2 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.GetMethod
object
3 properties
experiment.HostFile
object
4 properties
v1.DynatraceApmProbeInputs
object
3 properties
types.ExperimentRunRequest
object
2 properties
bulkaction.BulkAddTagsInExperimetsInput
object
2 properties
v1.SeccompProfileType
string
pipelines.CreatePipelineResponse
object
6 properties
experiment.Definition
object
2 properties
v1.ResourceList
object
model.Weightages
object
2 properties
chaos_experiment_run.ConditionDetails
object
4 properties
chaos_execution_nodes.HTTPProbe
object
3 properties
experiment.AuthType
string
chaos_experiment.FaultEventMetadata
object
3 properties
chaos_execution_nodes.ChaosData
object
3 properties
v1.DatadogApmProbeInputs
object
4 properties
model.WorkflowSortingField
string
github_com_harness_hce-saas_hce-sdk_common_probe_v1.DatadogSyntheticsTestType
string
types.TemplateResources
object
3 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.PostMethod
object
6 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.HTTPProbeInputs
object
6 properties
v1alpha1.Targets
object
6 properties
chaos_execution_nodes.ChaosExecutionNode
object
20 properties 1 required
model.Workflow
object
23 properties
experiment.ProbeRef
object
12 properties
types.DeleteChaosV2ExperimentResponse
object
3 properties
v1.FlexVolumeSource
object
5 properties
v1.DownwardAPIVolumeSource
object
2 properties
inputsets.CreateInputSetResponse
object
2 properties
inputsets.DeleteInputSetResponse
object
1 property
template.ChaosExperimentInputsetSpec
object
2 properties
chaos_execution_nodes.ChaosExecutionResponse
object
21 properties 1 required
v1.HostPathVolumeSource
object
2 properties
resource.Quantity
object
1 property
v1.SLOSourceMetadata
object
2 properties
v1.KeyToPath
object
3 properties
v1.SLOProbeInputs
object
7 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.DynatraceProbeInputs
object
5 properties
execution.ChaosStepStatus
string
v1.NewRelicMetric
object
2 properties
v1.DownwardAPIProjection
object
1 property
v1.QuobyteVolumeSource
object
6 properties
experiment.Application
object
2 properties
common.Volume
object
7 properties
v1.ProjectedVolumeSource
object
2 properties
types.UpdateCronExperimentAction
string
v1.VolumeMount
object
6 properties
experiment.SecurityContext
object
2 properties
pipelines.BulkExperimentRunResponse
object
2 properties
model.InfraScope
string
v1.Identifier
object
3 properties
v1.PhotonPersistentDiskVolumeSource
object
2 properties
v1.NewrelicMetrics
object
4 properties
chaos_execution_nodes.ProbeData
object
9 properties
v1.PrometheusInputs
object
3 properties
chaos_experiment_run.ChaosExperimentRun
object
39 properties 2 required
chaos_experiment_run.RuleDetails
object
7 properties
v1.AzureFileVolumeSource
object
3 properties
template.InputCategory
string
chaos_experiment.ExperimentRunDetail
object
12 properties 1 required
model.RecentWorkflowRun
object
10 properties
types.UpdateCronExperimentStateRequest
object
4 properties
bulkaction.BulkAddTagsInExperimetsResponse
object
v1.ManagedFieldsOperationType
string
template.Variable
object
13 properties 2 required
template.VariableMinimum
object
2 properties 2 required
v1.AppDynamicsInputs
object
2 properties
chaos_experiment_run.TemplateDetails
object
4 properties
chaosexperimentpipeline.GetChaosPipelineNodesResponse
object
2 properties
experiment.APIAuth
object
3 properties
model.EventMetadata
object
3 properties
experiment.WorkloadKind
string
github_com_harness_hce-saas_graphql_server_graph_model.Identifiers
object
3 properties
experiment.ProjectedVolumes
object
4 properties
experimenttemplate.ListExperimentTemplateData
object
5 properties
chaos_infrastructure_v2.K8sInfraV2SpecIdentifiers
object
10 properties
model.ReRunChaosWorkflowResponse
object
1 property
v1.EvaluationWindow
object
2 properties
v1.StorageMedium
string
v1.DownwardAPIVolumeFile
object
4 properties
v1.EnvVarSource
object
4 properties
model.ListWorkflowResponse
object
2 properties
v1.ConfigMapVolumeSource
object
4 properties
targetservice.ServiceMetadata
object
4 properties
experiment.Selector
object
1 property
model.ScenarioType
string
chaos_experiment_run.ExperimentType
string
github_com_harness_hce-saas_hce-sdk_common_probe_v1.Probe
object
18 properties
common.NodeAffinity
object
2 properties
v1.CinderVolumeSource
object
4 properties
types.UpdateCronExperimentStateResponse
object
2 properties
github_com_harness_hce-saas_graphql_server_pkg_chaos_v2_experiment_run_types.UserDetails
object
3 properties
types.Weightages
object
2 properties
chaos_experiment_run.SecurityGovernanceNode
object
7 properties
types.CreateNoteRequest
object
5 properties
common_types.ExperimentRunStats
object
3 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.TLSConfig
object
5 properties
handlers.MinimalNotificationWorkflow
object
5 properties
v1.PromProbeInputs
object
6 properties
v1.LabelSelectorRequirement
object
3 properties
model.InfrastructureType
string
v1.PersistentVolumeClaimSpec
object
7 properties
chaos_execution_nodes.ProbeIterations
object
6 properties
v1.DatadogMetrics
object
3 properties
v1.Capabilities
object
2 properties
v1.ObjectFieldSelector
object
2 properties
inputsets.ListInputSetResponse
object
3 properties
chaos_infrastructure_v2.ChaosInfraV2Spec
object
1 property
common.VolumeInputTemplate
object
4 properties
experiment.Secret
object
3 properties
experiment.Sidecar
object
5 properties
v1.TypedLocalObjectReference
object
3 properties
model.Infrastructure
object
20 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.RunProperty
object
9 properties
v1.VolumeProjection
object
4 properties
chaos_experiment_run.Action
object
2 properties
model.DateRange
object
2 properties
v1.NewRelicInputs
object
3 properties
bulkaction.BulkDeleteExperimetsResponse
object
v1.EnvFromSource
object
3 properties
v1.FieldsV1
object
v1.ContainerProbeInputs
object
22 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.DatadogProbeInputs
object
4 properties
experiment.StatusCheckTimeout
object
2 properties
v3.GetExperimentOrTemplateVariableData
object
2 properties
bulkaction.BulkDeleteExperimetsInput
object
1 property
experiment.ProbeConditions
object
1 property
types.CreateNoteResponse
object
1 property
chaos_experiment.ChaosExperimentType
string
chaos_experiment_run.Faults
object
2 properties
types.ExperimentCreationResponse
object
2 properties
experiment.HelperConfig
object
18 properties
experiment.VMWareAuth
object
7 properties
v1.ObjectMeta
object
16 properties
v1.ResourceFieldSelector
object
3 properties
model.TemplateRef
object
4 properties
github_com_harness_hce-saas_graphql_server_graph_model.UserDetails
object
3 properties
v1.PortworxVolumeSource
object
3 properties
chaos_infrastructure_v2.InfraScope
string
v1.AWSElasticBlockStoreVolumeSource
object
4 properties
v1.SeccompProfile
object
2 properties
v1.ResourceRequirements
object
2 properties
v1.SecretEnvSource
object
2 properties
common_types.ExperimentRunsData
object
3 properties
experiment.SSHFaultAuth
object
2 properties
template.RunTimeInputs
object
2 properties
pipelines.ChaosPipelineInput
object
5 properties
v1.PodSecurityContext
object
10 properties
v1.ServiceAccountTokenProjection
object
3 properties
chaos_experiment.SingleClickOnboardMetadata
object
2 properties
github_com_harness_hce-saas_graphql_server_api.Pagination
object
4 properties
chaos_experiment.Recommendation
object
3 properties
chaos_execution_nodes.ErrorData
object
2 properties
k8s_io_api_core_v1.EnvVar
object
3 properties
v1.ProcMountType
string
experiment.ChaosInputs
object
11 properties
security_governance.TimeWindow
object
5 properties 2 required
v1.LabelSelectorOperator
string
github_com_harness_hce-saas_hce-sdk_common_probe_v1.HTTPMethod
object
2 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.ComparatorInfo
object
3 properties
experiment.RedisAuth
object
2 properties
chaos_execution_nodes.CommandProbe
object
1 property
types.UpdateOperation
string
v1.SplunkObservabilityInputs
object
2 properties
types.Notes
object
7 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.Metrics
object
2 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.SyntheticsTest
object
2 properties
v1.TolerationOperator
string
v1.CephFSVolumeSource
object
6 properties
v1.PullPolicy
string
v1.VsphereVirtualDiskVolumeSource
object
4 properties
v3.GetExperimentOrTemplateVariableResponse
object
1 property
types.StopChaosV2ExperimentResponse
object
3 properties
v1.GcpCloudMonitoringInputs
object
3 properties
inputsets.CreateInputSetRequest
object
4 properties
chaosexperiment.ListExperimentData
object
6 properties
chaos_experiment_run.Probe
object
2 properties
api.RestError
object
3 properties
pipelines.ExperimentSpec
object
3 properties
model.WorkflowSortInput
object
2 properties
v1.TaintEffect
string
chaosexperimentpipeline.ReferenceEntities
object
3 properties
experiment.Workload
object
4 properties
v1.PodFSGroupChangePolicy
string
types.FilterListChaosPipelineRuns
object
1 property
experiment.FaultRef
object
6 properties
types.Note
object
5 properties
chaos_experiment_run.Annotation
object
4 properties
v1.ManagedFieldsEntry
object
6 properties
v1.FCVolumeSource
object
5 properties
handlers.ListExperimentsWithActiveInfrasMinimalNotificationResponse
object
2 properties
experiment.SaveChaosExperimentResponse
object
2 properties
chaos_experiment.WeightagesInput
object
2 properties
v1.GCEPersistentDiskVolumeSource
object
4 properties
model.WorkflowType
string
pipelines.VerifyChaosStageInPipelineRunResponse
object
1 property
types.ListMetadataRequest
object
1 property
experiment.ConfigMap
object
3 properties
shared.ListMetadataResponse
object
3 properties
inputsets.UpdateInputSetRequest
object
3 properties
model.ListWorkflowRequest
object
5 properties
types.ListExperimentV2Response
object
2 properties
v1.SELinuxOptions
object
4 properties
v1.SourceDetails
object
15 properties
v1.StorageOSVolumeSource
object
5 properties
chaos_execution_nodes.PromProbe
object
1 property
api.ResponseErrorCode
string
v1alpha1.TargetDetails
object
3 properties
v1.Authorization
object
2 properties
v1.LabelSelector
object
2 properties
v1.PersistentVolumeMode
string
v1.GitRepoVolumeSource
object
3 properties
shared.PaginationResponse
object
4 properties
github_com_harness_hce-saas_graphql_server_models_shared.Metadata
object
4 properties
v1.PersistentVolumeClaimVolumeSource
object
2 properties
types.ExperimentCreationRequest
object
16 properties
chaos_execution_nodes.FaultData
object
6 properties
types.UpdateNoteRequest
object
7 properties
v1.RBDVolumeSource
object
8 properties
v3.ListExperimentOrTemplateResponse
object
4 properties
v1.GlusterfsVolumeSource
object
3 properties
v1.Sysctl
object
2 properties
inputset.InputSet
object
15 properties 1 required
v1.ConfigMapProjection
object
3 properties
chaos_experiment.ChaosExperimentRequest
object
29 properties 3 required
chaos_experiment_run.SecurityGovernanceNodeData
object
3 properties
v1.PersistentVolumeAccessMode
string
inputsets.UpdateInputSetResponse
object
2 properties
types.ListChaosPipelineRuns
object
11 properties
chaos_execution_nodes.HelperPodDetails
object
2 properties
v1.AzureDataDiskCachingMode
string
v1.ConfigMapEnvSource
object
2 properties
v1.EmptyDirVolumeSource
object
2 properties
types.ExperimentV2
object
26 properties
v1.NewrelicProbeInputs
object
4 properties
chaos_execution_nodes.ActionData
object
2 properties
common.VolumeType
string
experiment.ExperimentComponents
object
15 properties
experiment.InfraType
string
security_governance.RecurrenceSpec
object
2 properties
inputsets.GetInputSetResponse
object
2 properties
v1.ConfigMapKeySelector
object
3 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.EnvVar
object
2 properties
handlers.ChaosExperimentRunsStatsResponse
object
1 property
v1.NFSVolumeSource
object
3 properties
v1.HostPathType
string
model.ClusterType
string
common.PreferredNodeSelector
object
4 properties
template.InputType
string
v1.SecurityContext
object
11 properties
v1.SecretKeySelector
object
3 properties
model.WorkflowFilterInput
object
10 properties
chaos_execution_nodes.FaultDetails
object
2 properties
v1.AzureDataDiskKind
string
github_com_harness_hce-saas_graphql_server_graph_model.Pagination
object
2 properties
v1.SecretProjection
object
3 properties
chaos_infrastructure_v2.ChaosInfraV2
object
17 properties 3 required
experiment.Targets
object
2 properties
v1.ISCSIVolumeSource
object
11 properties
experiment.ProbeActions
object
4 properties
v1.SplunkObservabilityMetrics
object
2 properties
v1.K8sProbeInputs
object
9 properties
model.WorkflowRunStatus
string
v1.AppdMetrics
object
3 properties
v1.SecretVolumeSource
object
4 properties
v1.OwnerReference
object
6 properties
v1.FlockerVolumeSource
object
2 properties
experiment.ActionRef
object
9 properties
v1.Toleration
object
5 properties
security_governance.Recurrence
object
2 properties 1 required
v1.ScaleIOVolumeSource
object
10 properties
github_com_harness_hce-saas_hce-sdk_common_probe_v1.CmdProbeInputs
object
4 properties
v1.PersistentVolumeClaimTemplate
object
2 properties
v1.CSIVolumeSource
object
5 properties
chaos_infrastructure_v2.InfraType
string
types.Infra
object
4 properties
v1.LocalObjectReference
object
1 property
types.TemplateResourceDetails
object
3 properties
common.RequiredNodeSelector
object
3 properties
v1.EphemeralVolumeSource
object
1 property
execution.ChaosStepType
string
v1.MountPropagationMode
string
v1.AzureDiskVolumeSource
object
6 properties
chaos_experiment.WorkflowRevision
object
9 properties
chaosresourcenotes.NoteType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-experiments-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 Experiments 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.