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 Registry V3 - Firewall API

V3 firewall endpoints

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

Tagged areas include Registry V3 - Firewall. 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 14 operations across 12 paths, and defines 48 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}.

14 operations 12 paths 48 schemas 1 DELETE6 GET5 POST2 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 Registry V3 - Firewall 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 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 6 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Registry V3 - Firewall 14

V3 firewall endpoints

POST
/har/api/v3/build-info
Add build info
AddBuildInfoV3 1 param body → 201default
GET
/har/api/v3/build-info/pipeline/details
List pipeline build info details
ListPipelineBuildInfoDetailsV3 14 params → 200default
GET
/har/api/v3/scans
Get the list of artifact scan result for a particular scope
GetArtifactScansV3 14 params → 200default
GET
/har/api/v3/scans/{id}/details
Get the details of a artifact scan
GetArtifactScanDetailsV3 3 params → 200default
POST
/har/api/v3/scans/bulk-evaluate
Initiate bulk scan evaluation
InitiateBulkScanEvaluationV3 3 params body → 202default
POST
/har/api/v3/scans/bulk-evaluate-sync
Synchronous bulk artifact scan evaluation (no DB write)
BulkEvaluateArtifactsV3 3 params body → 200default
GET
/har/api/v3/scans/bulk-evaluate/{evaluation_id}
Get bulk scan evaluation status
GetBulkScanEvaluationStatusV3 4 params → 200default
POST
/har/api/v3/scans/evaluate
Re-evaluate artifact scan
EvaluateArtifactScanV3 1 param body → 202default
GET
/har/api/v3/scans/exceptions
List firewall exceptions
ListFirewallExceptionsV3 13 params → 200default
POST
/har/api/v3/scans/exceptions
Create a firewall exception
CreateFirewallExceptionV3 1 param body → 201409default
DELETE
/har/api/v3/scans/exceptions/{id}
Delete a firewall exception
DeleteFirewallExceptionV3 2 params → 204default
PUT
/har/api/v3/scans/exceptions/{id}
Update a firewall exception
UpdateFirewallExceptionV3 2 params body → 200default
PUT
/har/api/v3/scans/exceptions/{id}/status
Update status of a firewall exception
UpdateStatusFirewallExceptionV3 2 params body → 200default
GET
/har/api/v3/scans/versions
List versions for firewall exceptions
ListFirewallExceptionVersionsV3 5 params → 200default

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are ArtifactScanV3 (23 properties), ArtifactScanDetailsV3 (22 properties), FirewallExceptionResponseV3 (20 properties), PipelineBuildInfoDetailV3 (12 properties). Each schema is shown below with its type and property counts.

PipelineBuildInfoMetaV3
object
Aggregated metadata for pipeline build info results.
2 properties
LicensePolicyFailureDetailConfigV3
object
License-specific failure detail payload.
2 properties 2 required
BuildInfoMetadataV3
array
List of dependency graph nodes for the build.
PolicySetFailureDetailV3
object
Policy set failure detail entry.
3 properties 3 required
ListPipelineBuildInfoDetailsResponseBodyV3
ErrorV3
object
An error response
1 property 1 required
BuildInfoRequestInputV3
object
Request to add build info
6 properties 5 required
PipelineContextV3
object
Pipeline execution context.
6 properties 5 required
OssRiskLevelPolicyFailureDetailConfigV3
object
OSS risk level-specific failure detail payload.
2 properties 1 required
ListFirewallExceptionsResponseBodyV3
ArtifactScanEvaluateRequestInputV3
object
Input for re-evaluate artifact scan. Exactly one of scanId or versionId must be provided.
2 properties
PipelineBuildInfoDetailV3
object
Pipeline build info detail entry.
12 properties 10 required
BulkScanResultItemV3
object
Individual scan result item
4 properties
ArtifactScanV3
object
23 properties 15 required
FixVersionDetailsV3
object
Fix version Details
3 properties 2 required
PolicyFailureDetailCategoryV3
string
Policy failure detail category.
ArtifactScanEvaluateRequestStatusV3
string
Status of the Artifact Scan Evaluate Request
PageInfoV3
object
Pagination metadata. - page selects which page of results to return (0 = first page). - size controls how many items are returned per page. - hasMore is true i…
3 properties 3 required
BulkScanEvaluationStatusDataV3
object
Response data for bulk scan evaluation status
4 properties
PolicyFailureDetailV3
object
Policy failure detail entry.
3 properties 3 required
UserInfoV3
object
Structured user information for a principal
4 properties
FirewallExceptionMetaV3
object
Metadata counts for firewall exceptions
5 properties 5 required
MaliciousPackagePolicyFailureDetailConfigV3
object
Malicious package failure detail payload.
3 properties 3 required
SecurityPolicyFailureDetailConfigV3
object
Security-specific failure detail payload.
1 property 1 required
ScanStatusV3
string
Status of an artifact scan evaluation.
FirewallExceptionCreateRequestV3
object
Request to create a firewall exception
6 properties 3 required
ScanMetaV3
object
Metadata about the list artifact scans
3 properties
FirewallExceptionApprovalRequestV3
object
Request to approve or reject a firewall exception
2 properties 1 required
RootPackageV3
object
Root package of the build
2 properties 2 required
ApiErrorsV3
object
4 properties 1 required
BulkScanEvaluateSyncRequestV3
object
Request body for synchronous bulk artifact scan evaluation. Maximum 50 artifacts per request. No data is written to the database.
3 properties 2 required
BulkScanEvaluationAcceptedDataV3
object
Response data for bulk scan evaluation request
1 property
SecurityPolicyFailureVulnerabilityV3
object
Security violation entry.
3 properties 3 required
PackageTypeV3
string
Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, HELMHTTP, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT, PUPP…
PackageAgeViolationPolicyFailureDetailConfigV3
object
Package age violation failure detail payload.
2 properties 2 required
BuildInfoNodeV3
object
Node in the build
2 properties 1 required
ExemptionStatusV3
object
Exemption status for an artifact, showing if an exception exists.
4 properties 3 required
BuildDetailsV3
array
List of build detail entries containing pipeline and package info.
ArtifactScanInputV3
object
Artifact to be scanned
2 properties 2 required
FirewallExceptionStatusV3
string
Status of the firewall exception
FirewallExceptionResponseV3
object
Firewall exception details
20 properties 11 required
FirewallExceptionUpdateRequestV3
object
Request to update a firewall exception. Only allowed when status is PENDING.
4 properties
BulkScanEvaluationRequestV3
object
Request to initiate bulk scan evaluation
2 properties 2 required
ArtifactScanDetailsV3
object
Artifact scans details
22 properties 13 required
PipelineBuildInfoViolationV3
object
A violation entry mapping a package key to a scan ID.
5 properties 5 required
PolicySetsV3
array
List of opa policy sets.
CreatedAtMsV3
integernull
Unix timestamp in milliseconds when the resource was created
BuildDetailEntryV3
object
Build detail entry for a single scan.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-registry-v3-firewall-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 Registry V3 - Firewall 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.