Sign in
indexer

Index a Manifest

By submitting a Manifest object to this endpoint Clair will fetch the layers, scan each layer's contents, and provide an index of discovered packages, repository and distribution information.

post/indexer/api/v1/index_report

Request body

hashDigestSchemaJson required— unresolved $ref
layersLayerSchemaJson[] — unresolved $ref

The OCI Layers making up the Image, in order.

Example request

{
  "hash": "sha256:fc84b5febd328eccaa913807716887b3eb5ed08bc22cc6933a9ebf82766725e3",
  "layers": [
    {
      "hash": "sha256:2f077db56abccc19f16f140f629ae98e904b4b7d563957a7fc319bd11b82ba36",
      "uri": "https://storage.example.com/blob/2f077db56abccc19f16f140f629ae98e904b4b7d563957a7fc319bd11b82ba36",
      "headers": {
        "Authoriztion": [
          "Bearer hunter2"
        ]
      }
    }
  ]
}

Response

IndexReport created.

Clients may want to avoid reading the body if simply submitting the manifest for later vulnerability reporting.

manifest_hashDigestSchemaJson required— unresolved $ref
statestring required

The current state of the index operation

errstring

An error message on event of unsuccessful index

successboolean required

A bool indicating succcessful index

packagesobject

A map of Package objects indexed by a document-local identifier.

distributionsobject

A map of Distribution objects indexed by a document-local identifier.

repositoryobject

A map of Repository objects indexed by a document-local identifier.

environmentsobject

A map of Environment arrays indexed by a Package's identifier.

Changes

No recorded changes to this endpoint across all 1 revision of this API.