Fix Plan

Fix plan request endpoints

Request fix plan

post

Requests a fix plan for a given SBOM. The client should poll this endpoint until meta_data.overall_status becomes "available".

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

querystringRequiredExample: Recommend a fix plan

sbom_idstringRequired

SBOM identifier captured from the projects API

Responses

200

Fix plan response returned

application/json

401

Unauthorized

post

/api/v1/explain

HTTPcURLJavaScriptPython

POST /api/v1/explain HTTP/1.1
Host: lineaje-gpt-service.v2.prod.veedna.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "query": "Recommend a fix plan",
  "sbom_id": "<sbom_id>"
}

{
  "meta_data": {
    "plan_details": [
      {
        "type": "premium",
        "vuln_fixed": [
          "CVE-2023-44487"
        ],
        "efforts": "high",
        "is_compatible": true
      }
    ],
    "overall_status": "available"
  }
}