Dependency Analytics icon

Dependency Analytics

Get data from Dependency Analytics API

Actions7

SBOM → Get

AI-generated

Summary

Retrieve a single SBOM by SHA identifier from the Trustify Dependency Analytics API.

Inputs

  • authMethod (required) — Authentication method. Options: 'trustifyClientCredentials' or 'rhtpaClientCredentials'.
  • baseURL (required) — Base URL for the Trustify API instance. Example: 'http://localhost:8080/api/v2/'.
  • identifierSha (required) — SHA identifier of the SBOM. Format: sha256:<64-hex> | sha384:<96-hex> | sha512:<128-hex>, or a normalized identifier without prefix. Providing a 64/96/128 hex string without the 'sha:' prefix triggers a validation error requiring the prefix.
  • outputMode — Shape of the returned data. Options: 'simplified' (default, condensed), 'raw' (full API response), 'selected' (custom fields via sbomSelectedFields).
  • sbomSelectedFields — When outputMode is 'selected', fields to include in the output. Multi-options include Authors, Data Licenses, Described By, Name, Version, PURL, SHA-256/384/512, Size, Suppliers, Version, etc. 'ID' is always included.
  • limit — Maximum number of results to return. Default: 50. Optional.

Output shape

Determined by outputMode parameter.

The operation consumes the specified input parameters, makes a GET request to /sbom/{identifierSha}, and returns shaped data. No side effects beyond the API request.

Examples

Example 1: Simplified output (default)

authMethod=trustifyClientCredentials, baseURL=https://rhtpa.stage.devshift.net/api/v2/, identifierSha=sha256:3a7bd3...; output returns {id, name, version, packages, size, sha256, described_by (simplified), document_id}.

Example 2: Raw output

authMethod=rhtpaClientCredentials, baseURL=http://localhost:8080/api/v2/, identifierSha=sha512:...; output returns the full, unmodified API response body.

Example 3: Selected fields output

authMethod=trustifyClientCredentials, baseURL=http://localhost:8080/api/v2/, identifierSha=sha256:..., outputMode=selected, sbomSelectedFields=[name, version, sha256]; output includes only those fields plus the mandatory 'id'.

Links

Discussion