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

The summaries of software composition analysis (SCA) results for apps in an organization.[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/30743751-08a1d64d-5913-409a-ac8a-7074ce5a62d7?action=collection%2Ffork&collection-url=entityId%3D30743751-08a1d64d-5913-409a-ac8a-7074ce5a62d7%26entityType%3Dcollection%26workspaceId%3Da63f69cc-5c31-4f2b-8d28-b647f83b9e97)

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

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

This API exposes 4 operations across 4 paths, and defines 10 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.

4 operations 4 paths 10 schemas 3 GET1 POST

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 sca 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 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

sca 4

The summaries of software composition analysis (SCA) results for apps in an organization. [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-colle…

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}/dependencies
List dependencies that match the search
SearchDependency 6 params → 200default
POST
/package_info
Retrieve package information (CVEs, licenses, and more) for a list of PURLs
RetrievePackageInfo body → 200default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are SCAPackage (17 properties), Dependency (5 properties), Error (4 properties), PackageInfo (3 properties). Each schema is shown below with its type and property counts.

PackageInfo
object
3 properties
TagWithString
object
2 properties 2 required
Error
object
4 properties 3 required
ScanLanguage
string
The analysis language identifier.
Tag
SCAPackage
object
Information about an SCA package
17 properties 13 required
ScanPlatform
string
The analysis platform identifier.
SuccessResponse
object
1 property 1 required
Dependency
object
5 properties 4 required
TagWithNumber
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-sca-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 findings API
Qwiet org_backup API