Skip to content

Revenera SBOM Insights API (1.0)

Revenera SBOM Insights offers APIs to manage your Software Bill of Materials (SBOM) via buckets and parts. It supports manual software parts creation as well as ingestion of SBOMs in various formats. It also supports various queries into the constructed SBOM data.

Download OpenAPI description
openapi3.json
openapi3.yaml
Languages
Servers
Mock server
https://sbominsightsapi.redocly.app/_mock/openapi3
SBOM Insights API URL - Production
https://sca-api.revenera.com
SBOM Insights API URL - Staging
https://sca-api.reveneratest.com

Archetypes

Archetypes represents master 'types' that would be used across the system.

Operations

Buckets

Buckets are used to store a set of SBOM parts. They can represent an organization's entities such as business units and product families, as well as top-level applications and their elements such as modules and containers. Buckets can be nested under other buckets to form a hierarchy.

Operations

Files

Files represent the codebase files comprising the SBOM part. Each file has a name, relative path, and hashes.

Operations

Importer

The Importer processes SBOM data imports from multiple data sources and creates SBOM parts for the selected Bucket. An import is performed via a job, which allows for a persisted record of the transaction along with its resulting data summary and any encountered errors.

Operations

Import SBOM Data

Request

Import Software Bill Of Materials into the system

Security
GlobalSession_header_Authorization(Required scopes:
sbom:bucket:create
sbom:bucket:delete
sbom:bucket:index
sbom:bucket:show
+41
)
Path
orgIdinteger(int64)required

Organization id

Example: 38808
Bodymultipart/form-datarequired
bucketIdinteger(int64)required

bucket id

Example: 205
filestring(binary)required

file to be uploaded

Example: "contents of the file in bytes that needs to be uploaded"
fileNamestring

name of the file

Example: "project_hello.json"
curl -i -X POST \
  https://sbominsightsapi.redocly.app/_mock/openapi3/sbom/v1/orgs/38808/import \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F bucketId=205 \
  -F 'file=contents of the file in bytes that needs to be uploaded' \
  -F fileName=project_hello.json

Responses

OK response.

Bodyapplication/json
jobIdinteger(int64)
Example: 812
messagestring
Example: "Import job QUEUED. Check the /jobs/{jobId} api for details."
Response
application/json
{
  "jobId": 812,
  "message": "Import job QUEUED. Check the /jobs/{jobId} api for details."
}

Jobs

Jobs are persisted transactions for background operations with a record of the transaction along with its resulting data summary and any encountered errors.

Operations

Parts

SBOM Parts represent open source, third-party, and commercial ingredients in a software application. An SBOM part can represent an operating system such as Linux with 60k+ files, individual files, a single binary, a source bundle for an open source component, and even fragments of code. Parts within an SBOM, and even across multiple SBOMs, are related to each other via links of various types including dependencies, found inside, related to, and several others.

Operations