generated: '2026-09-12'
method: derived
source: openapi/_original/harness-apis-openapi.yaml (Harness bundle from https://apidocs.harness.io/_bundle/index.yaml)
provider: Harness
providerId: harness
description: 'Harness ships request and response examples INSIDE its OpenAPI rather than in a separate example repository,
  and ships them at scale: 1,185 example sites across the contract. The apidocs.harness.io reference renders each
  of them in JSON and YAML with a live editor. This index records where they are so a consumer knows the examples
  are in the spec, not missing.'
location: in-spec
summary:
  example_sites: 1185
  response_examples: 1012
  request_examples: 173
  operations_with_examples: 401
  total_operations: 2883
rendered_at: https://apidocs.harness.io/
media_types:
- application/json
- application/yaml
sample_index:
- operationId: delete-environment
  path: /v1/orgs/{org}/projects/{project}/environments/{environment}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-environment
  path: /v1/orgs/{org}/projects/{project}/environments/{environment}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-org-scoped-environment
  path: /v1/orgs/{org}/environments/{environment}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-org-scoped-environment
  path: /v1/orgs/{org}/environments/{environment}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-account-scoped-environment
  path: /v1/environments/{environment}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-account-scoped-environment
  path: /v1/environments/{environment}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-infrastructure
  path: /v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-infrastructure
  path: /v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-org-scoped-infrastructure
  path: /v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-org-scoped-infrastructure
  path: /v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-account-scoped-infrastructure
  path: /v1/environments/{environment}/infrastructures/{infrastructure-definition}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-account-scoped-infrastructure
  path: /v1/environments/{environment}/infrastructures/{infrastructure-definition}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-trigger
  path: /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-trigger
  path: /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-pipeline
  path: /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-pipeline
  path: /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-input-set
  path: /v1/orgs/{org}/projects/{project}/input-sets/{input-set}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-input-set
  path: /v1/orgs/{org}/projects/{project}/input-sets/{input-set}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: getApprovalInstancesByExecutionId
  path: /v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id}
  method: GET
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: getApprovalInstancesByExecutionId
  path: /v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id}
  method: GET
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-template-acc
  path: /v1/templates/{template}/versions/{version}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-template-acc
  path: /v1/templates/{template}/versions/{version}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-template-org
  path: /v1/orgs/{org}/templates/{template}/versions/{version}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-template-org
  path: /v1/orgs/{org}/templates/{template}/versions/{version}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: delete-template-project
  path: /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - example-resp
- operationId: delete-template-project
  path: /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}
  method: DELETE
  kind: response
  status: '400'
  media_type: application/yaml
  named_examples:
  - example-resp
- operationId: UpdateAutoStoppingRule
  path: /gateway/lw/api/accounts/{account_id}/autostopping/rules
  method: POST
  kind: response
  status: '400'
  media_type: application/json
  named_examples:
  - error
- operationId: aida#analyze
  path: /pm/api/v1/aida/analyze
  method: POST
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: aida#generate
  path: /pm/api/v1/aida/generate
  method: POST
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: dashboard#metrics
  path: /pm/api/v1/dashboard
  method: GET
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: evaluate#evaluate
  path: /pm/api/v1/evaluate
  method: POST
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: evaluations#list
  path: /pm/api/v1/evaluations
  method: GET
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: evaluations#evaluation-input-signed-url
  path: /pm/api/v1/evaluations/evaluation-input-signed-url/{evaluation_id}
  method: GET
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: evaluations#getYaml
  path: /pm/api/v1/evaluations/getYaml
  method: GET
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: evaluations#find
  path: /pm/api/v1/evaluations/{id}
  method: GET
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: examples#list
  path: /pm/api/v1/examples
  method: GET
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: policies#list
  path: /pm/api/v1/policies
  method: GET
  kind: response
  status: '200'
  media_type: application/json
  named_examples: null
- operationId: policies#list
  path: /pm/api/v1/policies
  method: GET
  kind: response
  status: '400'
  media_type: application/json
  named_examples: null
- operationId: policies#list
  path: /pm/api/v1/policies
  method: GET
  kind: response
  status: '409'
  media_type: application/json
  named_examples: null
- operationId: policies#create
  path: /pm/api/v1/policies
  method: POST
  kind: response
  status: '201'
  media_type: application/json
  named_examples: null
note: sample_index is a first-40 sample of the example sites, not the full enumeration — the examples themselves
  live verbatim in the saved spec.