List Vulnerabilities

GEThttps://api.confident-ai.com/v2/vulnerabilities

Lists the vulnerabilities available to your Confident AI project one page at a time: the ones Confident AI ships first, then the ones your project defined. Filter by catalog category or by whether a vulnerability is built in.

GET/v2/vulnerabilities

curl -X GET "https://api.confident-ai.com/v2/vulnerabilities" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "vulnerabilities": [
      {
        "id": "<VULNERABILITY-ID>",
        "name": "Prompt Leakage",
        "description": "The system reveals its instructions or configuration.",
        "category": "Data Privacy",
        "builtIn": true,
        "numVulnerabilityTypes": 2
      }
    ],
    "totalVulnerabilities": 30,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/threats/vulnerabilities",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page of vulnerabilities to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of vulnerabilities per page, at most 100. Defaults to 25.
categorystring
Returns only vulnerabilities in this catalog category. An unknown category is rejected with the list of valid ones.
builtInenum
When true, returns only the vulnerabilities Confident AI ships; when false, only the ones your project defined. Omit to return both.

Response

List Vulnerabilities succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of vulnerabilities, with the total across all pages.
Show 4 propertiesHide 4 properties
- vulnerabilitieslist of objects
  The vulnerabilities for the current page: the ones Confident AI ships first, then this project's own.
  Show 6 propertiesHide 6 properties
  - idstring
    The id of the vulnerability. A built-in's id is its catalog name until this project customises it, and its generated id afterwards; both keep resolving.
  - namestring
    The name of the vulnerability, unique within the project.
  - descriptionstring | null
    What the vulnerability covers.
  - categorystring | null
    The catalog category the vulnerability belongs to, or null for one your project defined.
  - builtInboolean
    Whether Confident AI ships this vulnerability.
  - numVulnerabilityTypesinteger
    How many types this vulnerability breaks down into.
- totalVulnerabilitiesinteger
  The total number of vulnerabilities matching the query across all pages.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of vulnerabilities per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI