Remediation
Authorizations
AuthorizationstringRequired
Use the accessToken returned by the login endpoint as a Bearer token.
Body
querystringRequiredExample:
Recommend fix planssbom_idstringRequiredExample:
<SBOM-ID>guidstringOptionalExample:
Include the guid returned by the first call to poll for the result.
fea930da-2e1e-11ef-993f-0a58a9feac02Responses
200
Queued, not-ready, or completed remediation response (same schema in all three states).
application/json
response_timenumberOptionalExample:
0answerstring · nullableOptional
Markdown summary of the three fix plans. Null until the response is ready.
graphqlany · nullableOptional
query_suggestionsany · nullableOptional
view_detailsany · nullableOptional
columnany · nullableOptional
view_schemaany · nullableOptional
Greetingany · nullableOptional
guidstring · nullableOptionalExample:
fea930da-2e1e-11ef-993f-0a58a9feac02messagestring · nullableOptionalExample:
Request is QueuederrorbooleanOptionalExample:
falsepost/api/v1/explain
200
Queued, not-ready, or completed remediation response (same schema in all three states).
Authorizations
AuthorizationstringRequired
Use the accessToken returned by the login endpoint as a Bearer token.
Body
REVIEW: request body is a placeholder pending SME details.
sbom_idstringOptionalExample:
<SBOM-ID>planstring · enumOptionalExample:
REVIEW: confirm plan identifiers.
basic_planPossible values: Responses
200
REVIEW: response is a placeholder pending SME details.
application/json
objectOptional
post/PLACEHOLDER/apply-fix-plan
200
REVIEW: response is a placeholder pending SME details.
Last updated