> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zdlake.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Software

> Understand affected products, exact software identities, version scope, and related security activity.

Software represents a product that may be affected by a vulnerability. It includes packages, applications, operating systems, appliances, hardware devices, and firmware.

A Software record is versionless: it identifies the product, not every release of that product. Registry-observed releases are child records linked to Software, while affected version ranges, fixed versions, and remediation remain claims attached to vulnerabilities and advisories.

## When to use software

* Enrich an SBOM, application inventory, operating-system inventory, or device record with related vulnerabilities and advisories.
* Normalize package identity across ecosystems such as npm, Maven, PyPI, Go, or Debian.
* Connect affected-version claims from multiple publishers to one exact software identity.
* Inspect releases observed in the package registry and their vulnerability or advisory assessments.
* Build software-centered security activity views for product and dependency owners.

Do not interpret every vulnerability related to software as affecting every version. Match the deployed version against affected assertions and inspect provenance before creating remediation work.

## Software kinds

Every software record has a `kind`:

| Kind | Meaning |
| - | - |
| `package` | Software distributed through a package ecosystem and commonly identified by a PURL. |
| `application` | An application or source-described software product. |
| `operating_system` | Operating-system software. |
| `appliance` | Software delivered as part of an appliance. |
| `hardware` | A hardware product represented in affected-product data. |
| `firmware` | Firmware for a device or product. |

Package-specific fields such as `purl`, `ecosystem`, `namespace`, and `package_name` are optional for Software as a whole. They are populated only when they apply to a package-shaped record.

## Identity rules

Zero resolves software only from exact identifiers. It prefers a versionless PURL for packages, then a product-level CPE identity built from part, vendor, and product, then an exact publisher namespace and source product identifier. Display-name similarity alone never merges software records.

PURLs preserve package ecosystem, namespace, and name semantics. Version-specific CPE coordinates remain attached to the product as source evidence and affected-version data rather than creating duplicate Software records. A source-scoped identifier keeps a publisher's product identity distinct when no standard coordinate is available.

## Releases

For supported npm, PyPI, Cargo, and NuGet packages, Zero observes release versions and publication metadata from the package registry. Each release remains a child of its versionless Software identity. Release assessments compare the observed version with normalized affected ranges and report `affected`, `unaffected`, or `unknown` together with a reason. General web search does not create release records.

Registry observations do not replace publisher affected-version claims. The assessment connects those two records so consumers can distinguish a published release from a claim about whether that release is affected. Assessments are aggregated by vulnerability or advisory: `source_count` records how many source versions support the result, and `conflict` plus `conflicting_sources` makes disagreement explicit.

The `software_releases` projection returns at most 100 releases in ecosystem and ecosystem-correct version order. Each release returns at most 100 vulnerability or advisory subject assessments. Both levels include `_meta.total`, `_meta.limit`, and `_meta.truncated`; consumers must check `truncated` before treating either list as complete.

## Relationships

| Related concept | What the relationship explains |
| - | - |
| [Vulnerability](https://docs.zdlake.com/concepts/vulnerabilities.md) | Security issues associated with the software through affected assertions. |
| [Advisory](https://docs.zdlake.com/concepts/advisories.md) | Publisher notices that discuss the software or its releases. |
| [Weakness](https://docs.zdlake.com/concepts/weaknesses.md) | Flaw classes connected through related vulnerabilities or advisories. |
| [Attack pattern](https://docs.zdlake.com/concepts/attack-patterns.md) | Relevant attacker behavior when supported by the relationship evidence. |

## Schema

Every software detail response starts with these fields:

| Field | Meaning |
| - | - |
| `entity` | Always `software`. |
| `entity_id` | Durable Zero identifier for the entity. |
| `id` | Preferred product identifier, such as `pkg:npm/lodash` or a product-level CPE. |
| `aliases` | Alternate coordinates or source-specific identifiers. |
| `title` | Human-readable software name. |
| `summary` | Normalized software description when available. |
| `kind` | Software kind such as `package`, `application`, or `operating_system`. |
| `state` | Current lifecycle state of the entity. |
| `published_at` | Publication time when supplied by an upstream source. |
| `source_updated_at` | Most recent relevant upstream update time. |
| `updated_at` | Time Zero last updated the entity. |
| `revision_id` | Identifier for the normalized revision returned by the request. |

Request optional projections when you need more detail:

| Projection | Contents |
| - | - |
| `overview` | Software kind, applicable coordinates, and recent vulnerability and advisory links. |
| `security_activity` | Related vulnerabilities and advisories with relationship evidence. |
| `software_releases` | Up to 100 current registry-observed releases in deterministic ecosystem and semantic-version order, with bounded, source-aggregated vulnerability and advisory assessments and explicit truncation metadata. |
| `affected_targets` | Software, CPE, package, or repository targets represented in supporting claims. |
| `relationships` | Related entities grouped by type, including direction and supporting sources. |
| `provenance` | Evidence supporting software identity and normalized fields. |

Search responses are intentionally more compact than detail responses. Use the API pages for the complete request and response schemas.

## API pages

| Page | Use it for |
| - | - |
| [Search software](https://docs.zdlake.com/software/search.md) | Search and filter software records. |
| [Get software](https://docs.zdlake.com/software/get.md) | Retrieve one software record and request optional projections. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.