Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qwiet findings API

The results of a scan (which can include vulnerabilities, secrets, or insights).[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/9829310-156075f8-c7cf-4e2c-95fa-0823a3313658?action=collection%2Ffork&collection-url=entityId%3D9829310-156075f8-c7cf-4e2c-95fa-0823a3313658%26entityType%3Dcollection%26workspaceId%3Da63f69cc-5c31-4f2b-8d28-b647f83b9e97)

Qwiet findings API is one of 27 APIs that Qwiet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include findings. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 12 operations across 12 paths, and defines 22 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, https://app.shiftleft.io/api/v4.

12 operations 12 paths 22 schemas 8 GET4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://app.shiftleft.io/api/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Qwiet findings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken).

  • BearerToken — Use of the Qwiet API requires an access token, which is available via the Qwiet Dashboard (either under [Account Settings](https://app.shiftleft.io/user/profil…

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 8 GET, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

findings 12

The results of a scan (which can include vulnerabilities, secrets, or insights). [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/982…

GET
/orgs/{orgID}/apps/{appID}/findings
List app findings
ListAppFindings 21 params → 200default
GET
/orgs/{orgID}/compounds/named/{compoundName}/findingsdeprecated
List compound findings
ListCompoundFindingsDEPRECATED 21 params → 200default
GET
/orgs/{orgID}/compounds/byname/{compoundName}/findings
List compound findings
ListCompoundFindings 23 params → 200default
GET
/orgs/{orgID}/apps/{appID}/findings/{findingID}
Read app finding detail
ReadAppFinding 3 params → 200default
PUT
/orgs/{orgID}/apps/{appID}/findings/{findingID}/status
Set finding status
SetAppFindingStatus 3 params body → 200default
PUT
/orgs/{orgID}/apps/{appID}/findings/{findingID}/assignment
Set finding assignee
SetAppFindingAssignee 3 params body → 200default
PUT
/orgs/{orgID}/apps/{appID}/findings_status
Set multiple findings status
SetAppMultipleFindingsStatus 2 params body → 200default
PUT
/orgs/{orgID}/apps/{appID}/findings_assignment
Set multiple findings assignee
SetAppMultipleFindingsAssignee 2 params body → 200default
GET
/orgs/{orgID}/compounds/named/{compoundName}/sca/packages
Read the SCA packages of a compound scan
ReadCompoundSCAPackages 14 params → 200default
GET
/orgs/{orgID}/apps/{appID}/sca/packages
Read the count of multiple tags of an app.
ReadAppSCAPackages 10 params → 200default
GET
/orgs/{orgID}/findings
List org findings
ListOrgFindings 15 params → 200default
GET
/orgs/{orgID}/findings/summary
Read org findings summary
ReadOrgFindingsSummary 4 params → 200default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SCAPackage (17 properties), Scan (16 properties), Finding (14 properties), FindingsSummary (8 properties). Each schema is shown below with its type and property counts.

FindingAssigneeUpdate
object
1 property
NextPage
string
URL for the next page of results
Tag
Severity
string
The severity of a finding
Diff
string
SuccessResponse
object
1 property 1 required
FindingStatusUpdate
object
2 properties
OSSScan
object
3 properties 1 required
FindingsSummary
object
8 properties 1 required
SCAPackage
object
Information about an SCA package
17 properties 13 required
Finding
object
14 properties 4 required
MultipleFindingsStatusUpdate
object
2 properties
ScanPlatform
string
The analysis platform identifier.
Scan
object
16 properties 4 required
Error
object
4 properties 3 required
TagCount
MultipleFindingsAssigneeUpdate
object
2 properties
TagWithNumber
object
2 properties 2 required
TagWithString
object
2 properties 2 required
ScanLanguage
string
The analysis language identifier.
Assignment
string
Status
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-findings-api-openapi.yml Raw ↑

Other APIs Qwiet publishes across the network.

Qwiet alerting API
Qwiet analyze API
Qwiet app_groups API
Qwiet app_labels API
Qwiet apps API
Qwiet autofix API
Qwiet azureboard API
Qwiet branches API
Qwiet comments API
Qwiet compounds API
Qwiet org_backup API
Qwiet orgs API