Retrieve Vulnerability Definition

GET 
/definitions/:id/

Request

Path Parameters

id stringrequired

Responses

200

application/json

Schema

Schema

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 stringnullablerequired

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 integernullablerequired
Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30, null]
Default vulnerability severity.
• 10 - low
• 20 - medium
• 30 - high
cvss_vector stringnullablerequired

Possible values: <= 1024 characters

CVSS vector

cwe_id stringnullablerequired

Possible values: <= 16 characters

CWE id.

cwe_name stringnullablerequired

Possible values: <= 255 characters

CWE name

passive booleanrequired

Example (from schema)

{
  "id": "string",
  "name": "string",
  "desc": "string",
  "changed": "2024-09-18T08:50:21.903Z",
  "severity": 10,
  "cvss_vector": "string",
  "cwe_id": "string",
  "cwe_name": "string",
  "passive": true
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

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 stringrequired

Example (from schema)

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

404

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

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

Loading...