List Vulnerability Definitions

GET 
/definitions/

Request

Query Parameters

length integer

Number of results to return per page.

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

passive boolean
search string

A search term.

severity integer[]
Possible values: [10, 20, 30]
Default vulnerability severity.
• 10 - low
• 20 - medium
• 30 - high

Responses

200

application/json

Schema

Schema

count integer

Total number of results.

page_total integer

Total number of pages.

page integer

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integer

Number of results returned per page.

results

object[]

Array [

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Name of the vulnerability.
The maximum length is 255 characters.

desc stringnullable

Description of the vulnerability.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

severity integernullable

Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30, null]

Default vulnerability severity.

• 10 - low
• 20 - medium
• 30 - high

cvss_vector stringnullable

Possible values: <= 1024 characters

CVSS vector

cwe_id stringnullable

Possible values: <= 16 characters

CWE id.

cwe_name stringnullable

Possible values: <= 255 characters

CWE name

passive boolean

]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "name": "string",
      "desc": "string",
      "changed": "2024-07-29T15:51:28.071Z",
      "severity": 10,
      "cvss_vector": "string",
      "cwe_id": "string",
      "cwe_name": "string",
      "passive": true
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...