Zum Hauptinhalt springen

API Reference

This portal documents the curated public set of endpoints that integrations such as Cadence (CertHub’s public engineering example) use for export, tracer, and release write-back.

CertHub’s backends expose many more endpoints internally. Not all of them are published here. If you need access to additional operations, contact CertHub.

What you can get from each backend​

  • Tech Doc API: product structure (products, KU/KT), plus the KT schema that defines your form fields. Use it to resolve certhub-key mappings.
  • Records API: the actual record data (read, create, and update data rows within a KT), including QM lists and global elements where relevant.
  • Tracer API: traceability operations. Retrieve links between records (for example “system requirement → verification”), including batch retrieval and node attribute updates.
  • Document API: document histories and revisions.

How to use this section​

Each backend below groups the individual operations (GET/POST/PATCH/PUT) with request and response shapes. For end-to-end integration flows, start in the Guides section. For the things that usually cause confusion, such as IDs, permissions, and versioning, use the Concepts section first.