Search Packages

POST 
/code/api/v1/vulnerabilities/packages/search

Searching for packages by a given reauestBody.

Request

application/json

Body

required

filter object
fixableOnly booleanrequired
include Include (string)[]

Possible values: [errorCount, fixableErrorCount, file, repository, images]

limit doublerequired
offset doublerequired
q string
repositories string[]required
sortBy Sort (string)[]

Possible values: [errors]

statuses Status (string)[]

Possible values: [OPEN, SUPPRESS, PASS]

Responses

200

search packages

application/json

Schema

Schema

hasNext booleanrequired
packages object[]required
Array [
errorCount double
fileMetadataId string
fileMetadataPath string
fixableErrorCount double
images string[]
isRoot boolean
licensesMetadata object[]
Array [
isOsi booleanrequired
isSpdx booleanrequired
license stringrequired
]
packageId stringrequired
packageLanguage string
packageLicenses string[]required
packageName stringrequired
packageVersion stringrequired
repository object
name string
owner string
sourcePackageIds object[]nullable
Array [
sourcePackageId stringrequired
]
]

Example (from schema)

{
  "hasNext": true,
  "packages": [
    {
      "errorCount": 0,
      "fileMetadataId": "string",
      "fileMetadataPath": "string",
      "fixableErrorCount": 0,
      "images": [
        "string"
      ],
      "isRoot": true,
      "licensesMetadata": [
        {
          "isOsi": true,
          "isSpdx": true,
          "license": "string"
        }
      ],
      "packageId": "string",
      "packageLanguage": "string",
      "packageLicenses": [
        "string"
      ],
      "packageName": "string",
      "packageVersion": "string",
      "repository": {
        "name": "string",
        "owner": "string"
      },
      "sourcePackageIds": [
        {
          "sourcePackageId": "string"
        }
      ]
    }
  ]
}

Example 1

[
  {
    "errorCount": 2,
    "fileMetadataId": "8d79e5a6-399b-42c3-8678-1fc165ca72c5",
    "fixableErrorCount": 1,
    "packageId": "a11294e7-e2e8-44c4-b48e-20305eb0000d",
    "packageLicenses": [],
    "packageName": "validator",
    "packageVersion": "8.2.0"
  },
  {
    "errorCount": 2,
    "fileMetadataId": "8d79e5a6-399b-42c3-8678-1fc165ca72c5",
    "fixableErrorCount": 2,
    "packageId": "d1b67af0-f168-4370-9d65-084fb6b1fa17",
    "packageLicenses": [],
    "packageName": "validator",
    "packageVersion": "8.2.0"
  }
]

422

Request arguments validation error

Loading...