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

This contains APIs for Approvals.

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

Tagged areas include Approvals. 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 20 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 20 schemas 3 GET3 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 Approvals 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 — 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Approvals 7

This contains APIs for Approvals.

GET
/v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id}
Gets Approval Instances by Execution Id
getApprovalInstancesByExecutionId 7 params → 200400
POST
/v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id}
Approve or Reject an Execution by Pipeline Execution ID
addHarnessApprovalActivityByPipelineExecutionId 5 params body → 200400
POST
/pipeline/api/approvals/{approvalInstanceId}/harness/activity
Approve or Reject a Pipeline Execution
addHarnessApprovalActivity 2 params body → 400500default
GET
/iacm/api/orgs/{org}/projects/{project}/approvals
List approvals
approvals#list-approvals 9 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/approvals
Create approval
approvals#create-approval 3 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/approvals/{id}
Show approval
approvals#show-approval 4 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/approvals/{id}
Update approval
approvals#update-approval 4 params body → 200400401403404408409423

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are HarnessIacmApproval (12 properties), ApprovalInstanceResponse (10 properties), ApprovalInstanceResponseBody (8 properties), PipelineError (7 properties). Each schema is shown below with its type and property counts.

ApprovalInstanceResponse
object
This contains details of Approval Instance response
10 properties 4 required
PipelineErrorMetadata
object
This implements different error meta data objects
1 property
ValidationError
object
2 properties
PipelineError
object
This is Error entity as defined in Harness
7 properties
HarnessApprovalActivityRequestBody
object
Request Body for Harness Approval Activity
3 properties
ApprovalInstanceResponseBody
object
Response body for Approval Instance
8 properties
HarnessApprovalActivityRequest
object
Details of approval activity requested
4 properties 1 required
ResponseDTOApprovalInstanceResponse
object
4 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
ApproverInputDTO
object
Approver Input DTO
2 properties
ApproverInput
object
Custom data to capture at the time of approval
2 properties 2 required
ApprovalInstanceDetailsDTO
object
ResponseMessage
object
7 properties
ApprovalsCreateApprovalResponseBodyCreation
object
Create-ApprovalResponseBody result type (creation view)
1 property 1 required
CreateApprovalRequest
object
4 properties 3 required
UpdateApprovalRequest
object
3 properties 4 required
IaCMError
object
6 properties 6 required
ApprovalsShowApprovalResponseBodyStatusInfo
object
Show-ApprovalResponseBody result type (statusInfo view)
5 properties 3 required
HarnessIacmApproval
object
Approval is the representation for a single approval
12 properties 10 required
ApprovalResourceCollection
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-approvals-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 Approvals 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.