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

The applications submitted for analysis.[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/9829310-e9d0bf19-30bd-46f4-b40c-9df03d2a463a?action=collection%2Ffork&collection-url=entityId%3D9829310-e9d0bf19-30bd-46f4-b40c-9df03d2a463a%26entityType%3Dcollection%26workspaceId%3Da63f69cc-5c31-4f2b-8d28-b647f83b9e97)

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

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

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

10 operations 6 paths 12 schemas 1 DELETE5 GET2 PATCH2 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 apps 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 10

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

apps 10

The applications submitted for analysis. [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/9829310-e9d0bf19-30bd-46f4-b40c-9df03d2a463…

PUT
/orgs/{orgID}/apps
Create Apps
CreateApp 2 params body → 200default
GET
/orgs/{orgID}/apps
List apps
ListApps 2 params → 200default
DELETE
/orgs/{orgID}/apps/{appID}
Delete app
DeleteApp 4 params → 200default
GET
/orgs/{orgID}/apps/{appID}
Read app
ReadApp 4 params → 200default
GET
/orgs/{orgID}/apps/branches
List app branches
ListAppsBranches 5 params → 200default
GET
/orgs/{orgID}/apps/{appID}/configuration
Read app config
ReadAppConfig 2 params → 200default
PUT
/orgs/{orgID}/apps/{appID}/configuration
Update app config
UpdateAppConfig 2 params body → 200default
PATCH
/orgs/{orgID}/apps/{appID}/configuration
Patch app config
PatchAppConfig 2 params body → 200default
PATCH
/orgs/{orgID}/apps/{appID}/configuration/default_branch
Update Application Default Branch
UpdateAppDefaultBranch 2 params body → 200default
GET
/orgs/{orgID}/apps/{appID}/configuration/merged
Read merged app config
ReadMergedAppConfig 2 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are App (12 properties), AppSpec (4 properties), Error (4 properties), StatusLog (3 properties). Each schema is shown below with its type and property counts.

AppAnalysisConfiguration
object
App level analysis configuration
2 properties
TagWithString
object
2 properties 2 required
Error
object
4 properties 3 required
SecretsConfiguration
object
Secrets detection configuration
2 properties
Tag
AppSpec
object
contains the information necessary to provision an app.
4 properties 1 required
SuccessResponse
object
1 property 1 required
AppProvisionRequest
array
AppProvisionResponse
object
contains the results of a bulk apps provisioning.
3 properties
App
object
12 properties
TagWithNumber
object
2 properties 2 required
StatusLog
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-apps-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 autofix API
Qwiet azureboard API
Qwiet branches API
Qwiet comments API
Qwiet compounds API
Qwiet findings API
Qwiet org_backup API
Qwiet orgs API