diff --git a/404.html b/404.html index 117b3bbe45..72a9c49621 100644 --- a/404.html +++ b/404.html @@ -89,11 +89,33 @@
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
ClairV4 is a set of cooperating microservices which scan, index, and match your container's content with known vulnerabilities.
Email: Clair Team Web: Clair Team License: Apache License 2.0
@@ -829,7 +851,7 @@ DeleteN DELETE /notifier/api/v1/notification/{notification_id} Issues a delete of the provided notification id and all associated notifications. After this delete clients will no longer be able to retrieve notifications. -Parameters +Parameters NameInTypeRequiredDescription notification_idpathstringfalseA notification ID returned by a callback @@ -845,7 +867,7 @@ Parameters "message": "string" } -Responses +Responses StatusMeaningDescriptionSchema 200OKOKNone 400Bad RequestBad RequestError @@ -913,7 +935,7 @@ GET /notifier/api/v1/notification/{notification_id} By performing a GET with a notification_id as a path parameter, the client will retrieve a paginated response of notification objects. -Parameters +Parameters NameInTypeRequiredDescription notification_idpathstringfalseA notification ID returned by a callback page_sizequeryintfalseThe maximum number of notifications to deliver in a single page. @@ -982,7 +1004,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKA paginated list of notificationsPagedNotifications 400Bad RequestBad RequestError @@ -992,7 +1014,7 @@ This operation does not require authentication -Indexer +Indexer Index the contents of a Manifest @@ -1091,7 +1113,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyManifesttruenone @@ -1150,7 +1172,7 @@ Parameters "err": "" } -Responses +Responses StatusMeaningDescriptionSchema 201CreatedIndexReport CreatedIndexReport 400Bad RequestBad RequestError @@ -1230,7 +1252,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyBulkDeletetruenone @@ -1245,7 +1267,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKOKBulkDelete 400Bad RequestBad RequestError @@ -1312,7 +1334,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1328,7 +1350,7 @@ Responses +Responses StatusMeaningDescriptionSchema 204No ContentOKNone 400Bad RequestBad RequestError @@ -1395,7 +1417,7 @@ GET /indexer/api/v1/index_report/{manifest_hash} Given a Manifest's content addressable hash an IndexReport will be retrieved if exists. -Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1454,7 +1476,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKIndexReport retrievedIndexReport 400Bad RequestBad RequestError @@ -1534,7 +1556,7 @@ -Responses +Responses StatusMeaningDescriptionSchema 200OKIndexer StateState 304Not ModifiedIndexer State UnchangedNone @@ -1547,7 +1569,7 @@ Response He -Matcher +Matcher Retrieve a VulnerabilityReport for a given manifest's content addressable hash. @@ -1606,7 +1628,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1706,7 +1728,7 @@ Responses +Responses StatusMeaningDescriptionSchema 201CreatedVulnerabilityReport CreatedVulnerabilityReport 400Bad RequestBad RequestError @@ -1718,7 +1740,7 @@ Schemas -Page +Page @@ -1736,7 +1758,7 @@ Properties sizeintfalsenoneThe maximum number of elements in a page nextstringfalsenoneThe next id to submit to the api to continue paging -PagedNotifications +PagedNotifications @@ -1805,7 +1827,7 @@ Properties pageobjectfalsenoneA page object informing the client the next page to retrieve. If page.next becomes "-1" the client should stop paging. notifications[Notification]falsenoneA list of notifications within this page -Callback +Callback @@ -1823,7 +1845,7 @@ Properties notification_idstringfalsenonethe unique identifier for this set of notifications callbackstringfalsenonethe url where notifications can be retrieved -VulnSummary +VulnSummary @@ -1895,7 +1917,7 @@ Enumerate normalized_severityHigh normalized_severityCritical -Notification +Notification @@ -1958,7 +1980,7 @@ Properties reasonstringfalsenonethe reason for the notifcation, [added vulnerabilityVulnSummaryfalsenoneA summary of a vulnerability -Environment +Environment @@ -1978,7 +2000,7 @@ Properties introduced_inDigesttruenoneA digest string with prefixed algorithm. The format is described here: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#digestsDigests are used throughout the API to identify Layers and Manifests. distribution_idstringtruenoneThe distribution ID found in an associated IndexReport or VulnerabilityReport. -IndexReport +IndexReport @@ -2047,7 +2069,7 @@ Properties successbooleantruenoneA bool indicating succcessful index errstringtruenoneAn error message on event of unsuccessful index -VulnerabilityReport +VulnerabilityReport @@ -2158,7 +2180,7 @@ Properties package_vulnerabilitiesobjecttruenoneA mapping of Vulnerability.id lists indexed by Package.id. ยป additionalProperties[string]falsenonenone -Vulnerability +Vulnerability @@ -2231,7 +2253,7 @@ Enume normalized_severityHigh normalized_severityCritical -Distribution +Distribution @@ -2264,7 +2286,7 @@ Properties cpestringtruenonenone pretty_namestringtruenonenone -
DELETE /notifier/api/v1/notification/{notification_id}
Issues a delete of the provided notification id and all associated notifications. After this delete clients will no longer be able to retrieve notifications.
GET /notifier/api/v1/notification/{notification_id}
By performing a GET with a notification_id as a path parameter, the client will retrieve a paginated response of notification objects.
@@ -1091,7 +1113,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyManifesttruenone @@ -1150,7 +1172,7 @@ Parameters "err": "" } -Responses +Responses StatusMeaningDescriptionSchema 201CreatedIndexReport CreatedIndexReport 400Bad RequestBad RequestError @@ -1230,7 +1252,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyBulkDeletetruenone @@ -1245,7 +1267,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKOKBulkDelete 400Bad RequestBad RequestError @@ -1312,7 +1334,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1328,7 +1350,7 @@ Responses +Responses StatusMeaningDescriptionSchema 204No ContentOKNone 400Bad RequestBad RequestError @@ -1395,7 +1417,7 @@ GET /indexer/api/v1/index_report/{manifest_hash} Given a Manifest's content addressable hash an IndexReport will be retrieved if exists. -Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1454,7 +1476,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKIndexReport retrievedIndexReport 400Bad RequestBad RequestError @@ -1534,7 +1556,7 @@ -Responses +Responses StatusMeaningDescriptionSchema 200OKIndexer StateState 304Not ModifiedIndexer State UnchangedNone @@ -1547,7 +1569,7 @@ Response He -Matcher +Matcher Retrieve a VulnerabilityReport for a given manifest's content addressable hash. @@ -1606,7 +1628,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1706,7 +1728,7 @@ Responses +Responses StatusMeaningDescriptionSchema 201CreatedVulnerabilityReport CreatedVulnerabilityReport 400Bad RequestBad RequestError @@ -1718,7 +1740,7 @@ Schemas -Page +Page @@ -1736,7 +1758,7 @@ Properties sizeintfalsenoneThe maximum number of elements in a page nextstringfalsenoneThe next id to submit to the api to continue paging -PagedNotifications +PagedNotifications @@ -1805,7 +1827,7 @@ Properties pageobjectfalsenoneA page object informing the client the next page to retrieve. If page.next becomes "-1" the client should stop paging. notifications[Notification]falsenoneA list of notifications within this page -Callback +Callback @@ -1823,7 +1845,7 @@ Properties notification_idstringfalsenonethe unique identifier for this set of notifications callbackstringfalsenonethe url where notifications can be retrieved -VulnSummary +VulnSummary @@ -1895,7 +1917,7 @@ Enumerate normalized_severityHigh normalized_severityCritical -Notification +Notification @@ -1958,7 +1980,7 @@ Properties reasonstringfalsenonethe reason for the notifcation, [added vulnerabilityVulnSummaryfalsenoneA summary of a vulnerability -Environment +Environment @@ -1978,7 +2000,7 @@ Properties introduced_inDigesttruenoneA digest string with prefixed algorithm. The format is described here: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#digestsDigests are used throughout the API to identify Layers and Manifests. distribution_idstringtruenoneThe distribution ID found in an associated IndexReport or VulnerabilityReport. -IndexReport +IndexReport @@ -2047,7 +2069,7 @@ Properties successbooleantruenoneA bool indicating succcessful index errstringtruenoneAn error message on event of unsuccessful index
GET /indexer/api/v1/index_report/{manifest_hash}
Given a Manifest's content addressable hash an IndexReport will be retrieved if exists.
@@ -1606,7 +1628,7 @@ Parameters
@@ -232,7 +254,7 @@ DeleteN DELETE /notifier/api/v1/notification/{notification_id} Issues a delete of the provided notification id and all associated notifications. After this delete clients will no longer be able to retrieve notifications. -Parameters +Parameters NameInTypeRequiredDescription notification_idpathstringfalseA notification ID returned by a callback @@ -248,7 +270,7 @@ Parameters "message": "string" } -Responses +Responses StatusMeaningDescriptionSchema 200OKOKNone 400Bad RequestBad RequestError @@ -316,7 +338,7 @@ GET /notifier/api/v1/notification/{notification_id} By performing a GET with a notification_id as a path parameter, the client will retrieve a paginated response of notification objects. -Parameters +Parameters NameInTypeRequiredDescription notification_idpathstringfalseA notification ID returned by a callback page_sizequeryintfalseThe maximum number of notifications to deliver in a single page. @@ -385,7 +407,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKA paginated list of notificationsPagedNotifications 400Bad RequestBad RequestError @@ -395,7 +417,7 @@ This operation does not require authentication -Indexer +Indexer Index the contents of a Manifest @@ -494,7 +516,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyManifesttruenone @@ -553,7 +575,7 @@ Parameters "err": "" } -Responses +Responses StatusMeaningDescriptionSchema 201CreatedIndexReport CreatedIndexReport 400Bad RequestBad RequestError @@ -633,7 +655,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyBulkDeletetruenone @@ -648,7 +670,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKOKBulkDelete 400Bad RequestBad RequestError @@ -715,7 +737,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -731,7 +753,7 @@ Responses +Responses StatusMeaningDescriptionSchema 204No ContentOKNone 400Bad RequestBad RequestError @@ -798,7 +820,7 @@ GET /indexer/api/v1/index_report/{manifest_hash} Given a Manifest's content addressable hash an IndexReport will be retrieved if exists. -Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -857,7 +879,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKIndexReport retrievedIndexReport 400Bad RequestBad RequestError @@ -937,7 +959,7 @@ -Responses +Responses StatusMeaningDescriptionSchema 200OKIndexer StateState 304Not ModifiedIndexer State UnchangedNone @@ -950,7 +972,7 @@ Response He -Matcher +Matcher Retrieve a VulnerabilityReport for a given manifest's content addressable hash. @@ -1009,7 +1031,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1109,7 +1131,7 @@ Responses +Responses StatusMeaningDescriptionSchema 201CreatedVulnerabilityReport CreatedVulnerabilityReport 400Bad RequestBad RequestError @@ -1121,7 +1143,7 @@ Schemas -Page +Page @@ -1139,7 +1161,7 @@ Properties sizeintfalsenoneThe maximum number of elements in a page nextstringfalsenoneThe next id to submit to the api to continue paging -PagedNotifications +PagedNotifications @@ -1208,7 +1230,7 @@ Properties pageobjectfalsenoneA page object informing the client the next page to retrieve. If page.next becomes "-1" the client should stop paging. notifications[Notification]falsenoneA list of notifications within this page -Callback +Callback @@ -1226,7 +1248,7 @@ Properties notification_idstringfalsenonethe unique identifier for this set of notifications callbackstringfalsenonethe url where notifications can be retrieved -VulnSummary +VulnSummary @@ -1298,7 +1320,7 @@ Enumerate normalized_severityHigh normalized_severityCritical -Notification +Notification @@ -1361,7 +1383,7 @@ Properties reasonstringfalsenonethe reason for the notifcation, [added vulnerabilityVulnSummaryfalsenoneA summary of a vulnerability -Environment +Environment @@ -1381,7 +1403,7 @@ Properties introduced_inDigesttruenoneA digest string with prefixed algorithm. The format is described here: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#digestsDigests are used throughout the API to identify Layers and Manifests. distribution_idstringtruenoneThe distribution ID found in an associated IndexReport or VulnerabilityReport. -IndexReport +IndexReport @@ -1450,7 +1472,7 @@ Properties successbooleantruenoneA bool indicating succcessful index errstringtruenoneAn error message on event of unsuccessful index -VulnerabilityReport +VulnerabilityReport @@ -1561,7 +1583,7 @@ Properties package_vulnerabilitiesobjecttruenoneA mapping of Vulnerability.id lists indexed by Package.id. ยป additionalProperties[string]falsenonenone -Vulnerability +Vulnerability @@ -1634,7 +1656,7 @@ Enume normalized_severityHigh normalized_severityCritical -Distribution +Distribution @@ -1667,7 +1689,7 @@ Properties cpestringtruenonenone pretty_namestringtruenonenone -
@@ -494,7 +516,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyManifesttruenone @@ -553,7 +575,7 @@ Parameters "err": "" } -Responses +Responses StatusMeaningDescriptionSchema 201CreatedIndexReport CreatedIndexReport 400Bad RequestBad RequestError @@ -633,7 +655,7 @@ Parameters +Parameters NameInTypeRequiredDescription bodybodyBulkDeletetruenone @@ -648,7 +670,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKOKBulkDelete 400Bad RequestBad RequestError @@ -715,7 +737,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -731,7 +753,7 @@ Responses +Responses StatusMeaningDescriptionSchema 204No ContentOKNone 400Bad RequestBad RequestError @@ -798,7 +820,7 @@ GET /indexer/api/v1/index_report/{manifest_hash} Given a Manifest's content addressable hash an IndexReport will be retrieved if exists. -Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -857,7 +879,7 @@ Responses +Responses StatusMeaningDescriptionSchema 200OKIndexReport retrievedIndexReport 400Bad RequestBad RequestError @@ -937,7 +959,7 @@ -Responses +Responses StatusMeaningDescriptionSchema 200OKIndexer StateState 304Not ModifiedIndexer State UnchangedNone @@ -950,7 +972,7 @@ Response He -Matcher +Matcher Retrieve a VulnerabilityReport for a given manifest's content addressable hash. @@ -1009,7 +1031,7 @@ Parameters +Parameters NameInTypeRequiredDescription manifest_hashpathDigesttrueA digest of a manifest that has been indexed previous to this request. @@ -1109,7 +1131,7 @@ Responses +Responses StatusMeaningDescriptionSchema 201CreatedVulnerabilityReport CreatedVulnerabilityReport 400Bad RequestBad RequestError @@ -1121,7 +1143,7 @@ Schemas -Page +Page @@ -1139,7 +1161,7 @@ Properties sizeintfalsenoneThe maximum number of elements in a page nextstringfalsenoneThe next id to submit to the api to continue paging -PagedNotifications +PagedNotifications @@ -1208,7 +1230,7 @@ Properties pageobjectfalsenoneA page object informing the client the next page to retrieve. If page.next becomes "-1" the client should stop paging. notifications[Notification]falsenoneA list of notifications within this page -Callback +Callback @@ -1226,7 +1248,7 @@ Properties notification_idstringfalsenonethe unique identifier for this set of notifications callbackstringfalsenonethe url where notifications can be retrieved -VulnSummary +VulnSummary @@ -1298,7 +1320,7 @@ Enumerate normalized_severityHigh normalized_severityCritical -Notification +Notification @@ -1361,7 +1383,7 @@ Properties reasonstringfalsenonethe reason for the notifcation, [added vulnerabilityVulnSummaryfalsenoneA summary of a vulnerability -Environment +Environment @@ -1381,7 +1403,7 @@ Properties introduced_inDigesttruenoneA digest string with prefixed algorithm. The format is described here: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#digestsDigests are used throughout the API to identify Layers and Manifests. distribution_idstringtruenoneThe distribution ID found in an associated IndexReport or VulnerabilityReport. -IndexReport +IndexReport @@ -1450,7 +1472,7 @@ Properties successbooleantruenoneA bool indicating succcessful index errstringtruenoneAn error message on event of unsuccessful index
@@ -1009,7 +1031,7 @@ Parameters