Harness

Harness Approvals API

This contains APIs for Approvals.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id} List approval steps in a pipeline run · Gets Approval Instances by Execution Id #
Ask an LLM
“Which approval steps are waiting in a particular pipeline execution?”
“Can I filter a run's approvals by status or approval type?”
Tell an agent
Show the approval instances for pipeline execution {execution-id} in org {org} project {project}.
List {approval_status} approvals in execution {execution-id}.
POST /v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id} Approve or reject a run by its execution ID · Approve or Reject an Execution by Pipeline Execution ID #
Ask an LLM
“Can I approve a waiting pipeline knowing only its execution ID?”
“Is it possible to reject a pipeline run with a comment using the execution ID?”
Tell an agent
Take action {action} on pipeline execution {execution-id} in org {org} project {project}.
Reject execution {execution-id} by its run ID with comment {comments}.
POST /pipeline/api/approvals/{approvalInstanceId}/harness/activity Approve or reject an approval instance · Approve or Reject a Pipeline Execution #
Ask an LLM
“How do I approve a Harness approval step from a script?”
“Can I add comments and approver inputs when acting on an approval instance?”
Tell an agent
Submit {action} on approval instance {approvalInstanceId}.
Approve instance {approvalInstanceId} with action {action} and note {comments}.
GET /iacm/api/orgs/{org}/projects/{project}/approvals List IaC workspace approvals · List approvals #
Ask an LLM
“What infrastructure plan approvals are pending in my project?”
“Can I narrow IaCM approvals to one workspace or pipeline run?”
Tell an agent
List IaCM approvals in org {org} project {project}.
Show approvals for workspace {workspace} with status {status_type}.
POST /iacm/api/orgs/{org}/projects/{project}/approvals Create an IaC workspace approval · Create approval #
Ask an LLM
“How is an approval record created for an infrastructure workspace stage?”
“What pipeline stage details does a new IaCM approval need?”
Tell an agent
Create an approval for workspace {workspace_id} in {org}/{project}, execution {pipeline_execution_id}, stage {pipeline_stage_id}.
Open a {status} workspace approval for stage {pipeline_stage_id} of run {pipeline_execution_id}.
GET /iacm/api/orgs/{org}/projects/{project}/approvals/{id} Get one IaC workspace approval · Show approval #
Ask an LLM
“Who actioned a given infrastructure approval, and what is its status?”
“Can I look up a single IaCM approval by ID?”
Tell an agent
Show IaCM approval {id} in org {org} project {project}.
Get the status of workspace approval {id}.
PUT /iacm/api/orgs/{org}/projects/{project}/approvals/{id} Approve or reject an IaC workspace approval · Update approval #
Ask an LLM
“How do I mark an infrastructure plan approval as approved or rejected?”
“Can I record who actioned an IaCM approval?”
Tell an agent
Set IaCM approval {id} in {org}/{project} to status {status}.
Update workspace approval {id} to {status}, actioned by {actioned_by_email}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/authentication/harness-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-approvals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-approval-resource-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-approvals-show-approval-response-body-status-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-create-approval-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-update-approval-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-harness-approval-activity-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-approvals-create-approval-response-body-creation-schema.json

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/errors/harness-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-approvals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harness-approvals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Approvals API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:


# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-approvals-api-openapi.yml