Skip to main content
POST
Create Recommendation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
fix_class
enum<string>
required

V2 Wave 5A (API-IMPLEMENTATION-SPEC.md §9) — required on every POST /recommendations; drives the remediation-cost/effort assumptions and the counterfactual covariate reduction used to compute business_case.

Available options:
structural,
compensating,
patch
impact
enum<string>
required
Available options:
high,
medium,
quick_win
pattern_id
string
required
Minimum string length: 1
title
string
required
Required string length: 1 - 300
type
enum<string>
required
Available options:
code_fix,
config_change,
process,
monitoring
description
string
default:""
Maximum string length: 5000
effort
string
default:medium
Maximum string length: 50
expected_loops_prevented
integer
default:0
Required range: x >= 0
patterns
Patterns · object[]
rank
integer | null
Required range: x >= 1

Response

Successful Response