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 Ai compounds API

Multi-Language Apps are groups of applications that are scanned together as a single application. This is useful for applications that are a compound of various programming languages and configurations of frameworks.

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

Tagged areas include compounds. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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

11 operations 11 paths 19 schemas 1 DELETE9 GET1 PATCH

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 Ai compounds 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 11

Across 11 paths, the API surfaces 11 operations — 1 DELETE, 9 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

compounds 11

Multi-Language Apps are groups of applications that are scanned together as a single application. This is useful for applications that are a compound of various programming langua…

PATCH
/orgs/{orgID}/compounds/named/{compoundName}
Un/Archive Compound
ToggleCompoundArchive 2 params body → 200default
GET
/orgs/{orgID}/compounds/named/{compoundName}/scans/streamlined
List scans in a compound, returning a subset of the scan summary information
GetStreamlinedScans 5 params → 200default
GET
/orgs/{orgID}/compounds/named/{compoundName}/scans/{scanID}
Read compound scan
ReadCompoundScan 4 params → 200default
GET
/orgs/{orgID}/compounds/named/{compoundName}/branches
Read branches for compound
CompoundBranches 3 params → 200default
GET
/orgs/{orgID}/compounds/named/{compoundName}/scans
List Scans of Compound
ListScansInCompound 6 params → 200default
GET
/orgs/{orgID}/compounds
List Compounds
ListOrgCompounds 4 params → 200default
GET
/orgs/{orgID}/compounds/shallow/{compoundID}
Read shallow compound
ReadCompoundShallow 2 params → 200default
GET
/orgs/{orgID}/compounds/byid/{compoundID}/shallow
Read shallow compound by ID
ReadCompoundShallowByID 2 params → 200default
GET
/orgs/{orgID}/compounds/byname/{compoundName}/shallow
Read shallow compound by name
ReadCompoundShallowByName 2 params → 200default
DELETE
/orgs/{orgID}/compounds/{compoundID}
Delete compound
DeleteCompound 2 params → 200default
GET
/orgs/{orgID}/compounds/full/{compoundID}
Read full compound
ReadCompoundFull 2 params → 200default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Scan (16 properties), App (12 properties), StreamlinedScan (12 properties), ScanInfo (9 properties). Each schema is shown below with its type and property counts.

Tag
ShallowCompound
object
3 properties
Scan
object
16 properties 4 required
TagWithString
object
2 properties 2 required
NextPage
string
URL for the next page of results
SASTVulnCounts
object
4 properties 4 required
CompoundScanResponse
object
5 properties
FindingsSummary
object
8 properties 1 required
Error
object
4 properties 3 required
TagWithNumber
object
2 properties 2 required
Compound
object
3 properties
StreamlinedScan
object
12 properties 9 required
OSSScan
object
3 properties 1 required
ScanInfo
object
9 properties 4 required
TagCount
StatusLog
object
3 properties
SuccessResponse
object
1 property 1 required
SCAVulnCounts
App
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-ai-compounds-api-openapi.yml Raw ↑

Other APIs Qwiet Ai publishes across the network.

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