Skip to Content
CarbonFooterv2.0
API reference

API reference

Endpoints, request shapes, and response codes for the CarbonFooter API v2.

The machine-readable schema lives at /api/v2/openapi.json. Use it to generate typed clients — the pages here focus on how to call each endpoint.

https://carbonfooter.nl/api/v2

Endpoints

Scanning and /usage require an API key; send it as Authorization: Bearer <api_key>. The issue catalog (/issues) is a public, static file.

The original GET /api?target= endpoint is still served unchanged for existing plugins, with its own older response shape. It is frozen and is not part of v2.

Conventions

  • Every dimensioned value is { value, unit }. Counts are plain integers.
  • Every field is always present — unavailable values are null or [].
  • New fields may be added within v2; ignore unknown ones.
  • Responses from /scans and /usage carry an X-Request-Id header, and errors share one envelope. The issue catalog and the OpenAPI document are static files served from the CDN.

See Conventions and Compatibility for the full contract.

On this page