Informations

Version

0.0.1

Content negotiation

URI Schemes

  • http
  • https

Consumes

  • application/json

Produces

  • application/json

All endpoints

images

Method URI Name Summary
POST /api/imageReport create image report Create a new image report. Related packages and vulnerabilities are also created.
GET /api/images get images Search image by id or digest.
GET /api/packages/{IDorName}/images get package images List the images that contain the given package.
GET /api/vulnerabilities/{CVEID}/images get vulnerability images List the images that contain the given vulnerability.

packages

Method URI Name Summary
GET /api/images/{IDorDigest}/packages get image packages List the packages in an image.
GET /api/packages get packages Search packages by id, name and/or version.
GET /api/sources/{IDorRepoorSha}/packages get source packages
GET /api/sources/packages get source packages query List packages of the given source.
GET /api/vulnerabilities/{CVEID}/packages get vulnerability packages List packages that contain the given CVE id.

sources

Method URI Name Summary
POST /api/sourceReport create source report Create a new source report. Related packages and vulnerabilities are also created.
GET /api/packages/{IDorName}/sources get package sources List the sources containing the given package.
GET /api/sources get sourcs Search for sources by ID, repository, commit sha and/or organization.
GET /api/vulnerabiltities/{CVEID}/sources get vulnerability sources List sources that contain the given vulnerability.

vulnerabilities

Method URI Name Summary
GET /api/images/{IDorDigest}/vulnerabilities get image vulnerabilities List vulnerabilities from the given image.
GET /api/packages/{IDorName}/vulnerabilities get package vulnerabilities List vulnerabilities from the given package.
GET /api/sources/{IDorRepoorSha}/vulnerabilitites get source vulnerabilities
GET /api/sources/vulnerabilitites get source vulnerabilities query List vulnerabilities of the given source.
GET /api/vulnerabilities get vulnerabilities Search for vulnerabilities by CVE id.

Paths

Create a new image report. Related packages and vulnerabilities are also created. (CreateImageReport)

POST /api/imageReport

Parameters

Name Source Type Go type Separator Required Default Description
Image body Image models.Image

All responses

Code Status Description Has headers Schema
200 OK Image schema
default ErrorMessage schema

Responses

200 - Image

Status: OK

Schema

Image

Default Response

ErrorMessage

Schema

ErrorMessage

Create a new source report. Related packages and vulnerabilities are also created. (CreateSourceReport)

POST /api/sourceReport

Parameters

Name Source Type Go type Separator Required Default Description
Image body Source models.Source

All responses

Code Status Description Has headers Schema
200 OK Source schema
default ErrorMessage schema

Responses

200 - Source

Status: OK

Schema

Source

Default Response

ErrorMessage

Schema

ErrorMessage

List the packages in an image. (GetImagePackages)

GET /api/images/{IDorDigest}/packages

Parameters

Name Source Type Go type Separator Required Default Description
IDorDigest path string string

All responses

Code Status Description Has headers Schema
200 OK Package schema
default ErrorMessage schema

Responses

200 - Package

Status: OK

Schema

[][Package](#package)

Default Response

ErrorMessage

Schema

ErrorMessage

List vulnerabilities from the given image. (GetImageVulnerabilities)

GET /api/images/{IDorDigest}/vulnerabilities

Parameters

Name Source Type Go type Separator Required Default Description
IDorDigest path string string

All responses

Code Status Description Has headers Schema
200 OK Vulnerability schema
default ErrorMessage schema

Responses

200 - Vulnerability

Status: OK

Schema

[][Vulnerability](#vulnerability)

Default Response

ErrorMessage

Schema

ErrorMessage

Search image by id or digest. (GetImages)

GET /api/images

Parameters

Name Source Type Go type Separator Required Default Description
digest query string string
id query int64 (formatted integer) int64

All responses

Code Status Description Has headers Schema
200 OK Image schema
default ErrorMessage schema

Responses

200 - Image

Status: OK

Schema

Image

Default Response

ErrorMessage

Schema

ErrorMessage

List the images that contain the given package. (GetPackageImages)

GET /api/packages/{IDorName}/images

Parameters

Name Source Type Go type Separator Required Default Description
IDorName path string string

All responses

Code Status Description Has headers Schema
200 OK Image schema
default ErrorMessage schema

Responses

200 - Image

Status: OK

Schema

[][Image](#image)

Default Response

ErrorMessage

Schema

ErrorMessage

List the sources containing the given package. (GetPackageSources)

GET /api/packages/{IDorName}/sources

Parameters

Name Source Type Go type Separator Required Default Description
IDorName path string string

All responses

Code Status Description Has headers Schema
200 OK Source schema
default ErrorMessage schema

Responses

200 - Source

Status: OK

Schema

[][Source](#source)

Default Response

ErrorMessage

Schema

ErrorMessage

List vulnerabilities from the given package. (GetPackageVulnerabilities)

GET /api/packages/{IDorName}/vulnerabilities

Parameters

Name Source Type Go type Separator Required Default Description
IDorName path string string

All responses

Code Status Description Has headers Schema
200 OK Vulnerability schema
default ErrorMessage schema

Responses

200 - Vulnerability

Status: OK

Schema

[][Vulnerability](#vulnerability)

Default Response

ErrorMessage

Schema

ErrorMessage

Search packages by id, name and/or version. (GetPackages)

GET /api/packages

Parameters

Name Source Type Go type Separator Required Default Description
id query int64 (formatted integer) int64 Any of id or name must be provided
name query string string Any of id or name must be provided
version query string string

All responses

Code Status Description Has headers Schema
200 OK Package schema
default ErrorMessage schema

Responses

200 - Package

Status: OK

Schema

[][Package](#package)

Default Response

ErrorMessage

Schema

ErrorMessage

get source packages (GetSourcePackages)

GET /api/sources/{IDorRepoorSha}/packages

Parameters

Name Source Type Go type Separator Required Default Description
IDorRepoorSha path string string

All responses

Code Status Description Has headers Schema
200 OK Package schema
default ErrorMessage schema

Responses

200 - Package

Status: OK

Schema

[][Package](#package)

Default Response

ErrorMessage

Schema

ErrorMessage

List packages of the given source. (GetSourcePackagesQuery)

GET /api/sources/packages

Parameters

Name Source Type Go type Separator Required Default Description
id query uint64 (formatted integer) uint64
repo query string string
sha query string string

All responses

Code Status Description Has headers Schema
200 OK Package schema
default ErrorMessage schema

Responses

200 - Package

Status: OK

Schema

[][Package](#package)

Default Response

ErrorMessage

Schema

ErrorMessage

get source vulnerabilities (GetSourceVulnerabilities)

GET /api/sources/{IDorRepoorSha}/vulnerabilitites

Parameters

Name Source Type Go type Separator Required Default Description
IDorRepoorSha path string string

All responses

Code Status Description Has headers Schema
200 OK Vulnerability schema
default ErrorMessage schema

Responses

200 - Vulnerability

Status: OK

Schema

[][Vulnerability](#vulnerability)

Default Response

ErrorMessage

Schema

ErrorMessage

List vulnerabilities of the given source. (GetSourceVulnerabilitiesQuery)

GET /api/sources/vulnerabilitites

Parameters

Name Source Type Go type Separator Required Default Description
id query uint64 (formatted integer) uint64
repo query string string
sha query string string

All responses

Code Status Description Has headers Schema
200 OK Vulnerability schema
default ErrorMessage schema

Responses

200 - Vulnerability

Status: OK

Schema

[][Vulnerability](#vulnerability)

Default Response

ErrorMessage

Schema

ErrorMessage

Search for sources by ID, repository, commit sha and/or organization. (GetSourcs)

GET /api/sources

All responses

Code Status Description Has headers Schema
200 OK Source schema
default ErrorMessage schema

Responses

200 - Source

Status: OK

Schema

[][Source](#source)

Default Response

ErrorMessage

Schema

ErrorMessage

Search for vulnerabilities by CVE id. (GetVulnerabilities)

GET /api/vulnerabilities

Parameters

Name Source Type Go type Separator Required Default Description
CVEID query string string

All responses

Code Status Description Has headers Schema
200 OK Vulnerability schema
default ErrorMessage schema

Responses

200 - Vulnerability

Status: OK

Schema

[][Vulnerability](#vulnerability)

Default Response

ErrorMessage

Schema

ErrorMessage

List the images that contain the given vulnerability. (GetVulnerabilityImages)

GET /api/vulnerabilities/{CVEID}/images

Parameters

Name Source Type Go type Separator Required Default Description
CVEID path string string

All responses

Code Status Description Has headers Schema
200 OK Image schema
default ErrorMessage schema

Responses

200 - Image

Status: OK

Schema

[][Image](#image)

Default Response

ErrorMessage

Schema

ErrorMessage

List packages that contain the given CVE id. (GetVulnerabilityPackages)

GET /api/vulnerabilities/{CVEID}/packages

Parameters

Name Source Type Go type Separator Required Default Description
CVEID path string string

All responses

Code Status Description Has headers Schema
200 OK Package schema
default ErrorMessage schema

Responses

200 - Package

Status: OK

Schema

[][Package](#package)

Default Response

ErrorMessage

Schema

ErrorMessage

List sources that contain the given vulnerability. (GetVulnerabilitySources)

GET /api/vulnerabiltities/{CVEID}/sources

Parameters

Name Source Type Go type Separator Required Default Description
CVEID path string string

All responses

Code Status Description Has headers Schema
200 OK Source schema
default ErrorMessage schema

Responses

200 - Source

Status: OK

Schema

[][Source](#source)

Default Response

ErrorMessage

Schema

ErrorMessage

Models

DeletedAt

ErrorMessage

ErrorMessage wraps an error message in a struct so responses are properly marshalled as a JSON object.

Properties

Name Type Go type Required Default Description Example
Message string string in: body something went wrong

Image

Properties

Name Type Go type Required Default Description Example
Digest string string 9n38274ods897fmay487gsdyfga678wr82
ID uint64 (formatted integer) uint64
Name string string myorg/application
Packages [][Package](#package) []*Package
Registry string string docker.io
Sources [][Source](#source) []*Source

MethodType

Properties

Name Type Go type Required Default Description Example
CreatedAt date-time (formatted string) strfmt.DateTime
DeletedAt DeletedAt DeletedAt
ID uint64 (formatted integer) uint64
Name string string
Rating [][Rating](#rating) []*Rating
UpdatedAt date-time (formatted string) strfmt.DateTime

Model

Model a basic GoLang struct which includes the following fields: ID, CreatedAt, UpdatedAt, DeletedAt It may be embedded into your model or you may build your own model without it type User struct { gorm.Model }

Properties

Name Type Go type Required Default Description Example
CreatedAt date-time (formatted string) strfmt.DateTime
DeletedAt DeletedAt DeletedAt
ID uint64 (formatted integer) uint64
UpdatedAt date-time (formatted string) strfmt.DateTime

NullTime

NullTime implements the Scanner interface so it can be used as a scan destination, similar to NullString.

Properties

Name Type Go type Required Default Description Example
Time date-time (formatted string) strfmt.DateTime
Valid boolean bool

Package

Properties

Name Type Go type Required Default Description Example
Homepage string string
ID uint64 (formatted integer) uint64
Images [][Image](#image) []*Image
Name string string
PackageManager string string
Sources [][Source](#source) []*Source
Version string string
Vulnerabilities [][Vulnerability](#vulnerability) []*Vulnerability

Rating

Properties

Name Type Go type Required Default Description Example
ID uint64 (formatted integer) uint64
MethodType MethodType MethodType
MethodTypeID uint64 (formatted integer) uint64
Score double (formatted number) float64
Severity string string
Vector string string

Source

Properties

Name Type Go type Required Default Description Example
DeletedAt DeletedAt DeletedAt
Host string string gitlab.com
ID uint64 (formatted integer) uint64
Images [][Image](#image) []*Image
Organization string string vmware
Packages [][Package](#package) []*Package
Repository string string myproject
Sha string string 0eb5fcd1

StringArray

[]string

Vulnerability

Properties

Name Type Go type Required Default Description Example
CNA string string
CVEID string string CVE-7467-2020
Description string string
ID uint64 (formatted integer) uint64
Packages [][Package](#package) []*Package
Ratings [][Rating](#rating) []*Rating
References StringArray StringArray
URL string string
check-circle-line exclamation-circle-line close-line
Scroll to top icon