Skip to content

Files

Latest commit

 

History

History
30 lines (21 loc) · 1.24 KB

internal-api.adoc

File metadata and controls

30 lines (21 loc) · 1.24 KB

Internal API endpoints for Clair

Internal API endpoints are embedded in /api/v1/internal and are meant for communication between Clair microservices.

Important

  • If your Clair config.yaml file is set to CLAIR_MODE=combo, internal API endpoints might not exist.

  • APIs are not formally exposed in Clair’s OpenAPI Specification. Further information and usage is dependent on the reader.

Update diffs

The update_diff endpoint exposes the API for diffing two update operations. This parameter is used by the notifier to determine the added and removed vulnerabilities on security database updates.

Update operation

The update_operation endpoint exposes the API for viewing updaters activity. This is used by the notifier to determine if new updates have occurred, and triggers an update diff to see what has changed.

AffectedManifest

The affected_manifest endpoint exposes the API for retrieving affected manifests given a list of vulnerabilities. This is used by the notifier to determine the manifests that need to have a notification generated.