Harness

Harness Registry V3 - Firewall API

V3 firewall endpoints

GitHub OpenAPI

Operations 14

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

POST /har/api/v3/build-info Record build info from a package install · Add build info #
Ask an LLM
“How does the CLI report package installation build info to the registry?”
“Can I attach pipeline context to the build info I record?”
Tell an agent
Add build info for root package {root_package} in registry {registry} with status {status}.
Record build info of package type {package_type} for account {account}.
GET /har/api/v3/build-info/pipeline/details List pipeline build info details · List pipeline build info details #
Ask an LLM
“Which pipelines installed a given package version?”
“Can I filter pipeline build info by scan id or package type?”
Tell an agent
List pipeline build info for package {package} version {version}.
Show build info details from pipeline {pipeline_id} in account {account}.
GET /har/api/v3/scans List artifact firewall scan results · Get the list of artifact scan result for a particular scope #
Ask an LLM
“Which artifacts in my registries were flagged by firewall scans?”
“Can I filter scan results by scan status or policy set?”
Tell an agent
List artifact scans with status {scan_status} in account {account}.
Show firewall scan results for registries {registry_ids}.
GET /har/api/v3/scans/{id}/details Get the details of one artifact scan · Get the details of a artifact scan #
Ask an LLM
“Why was a specific artifact blocked by the firewall scan?”
“Can I see the full findings recorded for one scan?”
Tell an agent
Show details of artifact scan {scan_id}.
Get scan {scan_id} details evaluated against policy set {policy_set}.
POST /har/api/v3/scans/bulk-evaluate Start an asynchronous bulk firewall evaluation · Initiate bulk scan evaluation #
Ask an LLM
“Can I trigger firewall policy evaluation for many artifacts in the background?”
“How do I kick off an asynchronous bulk scan evaluation?”
Tell an agent
Start a bulk firewall evaluation of artifacts {artifacts} in registry {registry}.
Queue background policy evaluation for registry {registry} covering {artifacts}.
POST /har/api/v3/scans/bulk-evaluate-sync Evaluate up to 50 artifacts synchronously · Synchronous bulk artifact scan evaluation (no DB write) #
Ask an LLM
“Can I get firewall results immediately for a batch of artifacts without saving anything?”
“What's the limit on artifacts in a synchronous bulk evaluation?”
Tell an agent
Synchronously evaluate artifacts {artifacts} against firewall policies in registry {registry}.
Evaluate {artifacts} right now without recording results, skip cache {skip_cache}.
GET /har/api/v3/scans/bulk-evaluate/{evaluation_id} Check a bulk scan evaluation's status · Get bulk scan evaluation status #
Ask an LLM
“Is my bulk firewall evaluation finished?”
“Where do I check progress on a bulk scan evaluation I started earlier?”
Tell an agent
Get status of bulk evaluation {evaluation_id}.
Check whether bulk scan evaluation {evaluation_id} completed in account {account}.
POST /har/api/v3/scans/evaluate Re-evaluate an artifact scan · Re-evaluate artifact scan #
Ask an LLM
“Can I rerun the firewall evaluation for an artifact after a policy change?”
“How do I re-evaluate a specific artifact version's scan?”
Tell an agent
Re-evaluate scan {scan_id}.
Rerun the firewall evaluation for version {version_id}.
GET /har/api/v3/scans/exceptions List firewall exceptions · List firewall exceptions #
Ask an LLM
“Which firewall exceptions are still pending approval?”
“Can I find the exceptions granted for a particular package?”
Tell an agent
List firewall exceptions with status {status}.
Show firewall exceptions for package {package} in account {account}.
POST /har/api/v3/scans/exceptions Request a firewall exception for a package · Create a firewall exception #
Ask an LLM
“What does it take to request an exception so a blocked package can be used?”
“Can a firewall exception expire automatically after a set time?”
Tell an agent
Create a firewall exception for package {package} in registry {registry} because {justification}.
Request an exception for {package} versions {versions} expiring after {expire_after}.
DELETE /har/api/v3/scans/exceptions/{id} Delete a firewall exception · Delete a firewall exception #
Ask an LLM
“Is there a way to withdraw a firewall exception entirely?”
“Can a firewall exception be removed by its id?”
Tell an agent destructive · confirm first
Delete firewall exception {exception_id}.
Remove exception {exception_id} from account {account}.
PUT /har/api/v3/scans/exceptions/{id} Edit a pending firewall exception · Update a firewall exception #
Ask an LLM
“Can I change the justification on an exception that's still pending?”
“Why can't I edit a firewall exception once it's no longer pending?”
Tell an agent
Update pending exception {exception_id} with remediation plan {plan}.
Change the expiry of firewall exception {exception_id} to {expire_after}.
PUT /har/api/v3/scans/exceptions/{id}/status Approve or reject a firewall exception · Update status of a firewall exception #
Ask an LLM
“How do I approve a pending firewall exception?”
“Can I leave notes when rejecting an exception request?”
Tell an agent
Approve firewall exception {exception_id}.
Set exception {exception_id} to {status} with notes {notes}.
GET /har/api/v3/scans/versions List package versions eligible for an exception · List versions for firewall exceptions #
Ask an LLM
“Which versions of a package can I include in a firewall exception?”
“Can I list a package's versions in a registry before requesting an exception?”
Tell an agent
List versions of package {package} in registry {registry} for an exception.
Show exception-eligible versions of {package}.

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-registry-v3-firewall-api-openapi.yml

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-registry-v3-firewall-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-registry-v3-firewall-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Registry V3 - Firewall 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 (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-registry-v3-firewall-api-openapi.yml