Skip to main content

Make your first request

Start with a call that needs only your API key. No product, KU, or KT IDs.

Generate a key first: Authentication. Production hosts are listed on Environments and base URLs.

List the products you can access​

curl "https://techdoc.prod.certhub-containers.containers.certhub.tech/products/" \
  -H "X-API-Key: YOUR_API_KEY"

What this call does​

  • It uses the Tech Doc API (GET /products/)
  • It returns the latest revision of each product your key can see
  • You do not pass any IDs. That makes it a useful smoke test that auth and the host are correct.

In the JSON, note each product’s history ID and the nested knowledge units / knowledge topics. Those IDs are what later Records and Tracer calls need. How history vs revision IDs differ: IDs and relationships.

Common first-call errors​

If you get a 401: your API key is wrong, expired, or missing. Regenerate it in Settings → API Keys (Authentication).

If you get an empty list: the key works, but that user has no product access yet. Open the CertHub dashboard with the same account, or ask your admin to grant product access (Permissions).

Next: list records in a knowledge topic​

Once you have a KT revision ID from Tech Doc (or from IDs and relationships), list its rows with the Records API:

curl "https://records.prod.certhub-containers.containers.certhub.tech/records/?context__knowledge_unit_topic_id=YOUR_KT_REVISION_ID" \
  -H "X-API-Key: YOUR_API_KEY"

Use a revision ID here, not the dashboard history ID. An empty [] usually means those two were mixed up.

Download OpenAPI files​

Static copies of each specification are published with the site:

Import these files into tools such as Postman, Insomnia, or code generators. Interactive request sending is disabled in this portal.

Working example

Want to see a full integration instead of individual requests? Cadence (CertHub’s public engineering example) implements export, tracer, and release write-back end to end. See Working example.

Next steps​