API Definition

Clair provides its API definition via an OpenAPI specification. You can view our OpenAPI spec here

The OpenAPI spec can be used in a variety of ways.

  • Generating http clients for your application
  • Validating data returned from Clair
  • Importing into a rest client such as Postman
  • API documentation via Swagger Editor

See Testing Clair to learn how the local dev tooling starts a local swagger editor. This is handy for making changes to the spec in real time.

See API Reference for a markdown rendered API reference.