List policy recommendations

Return stored FireGuard-style policy recommendations generated from failing RedRaven policies.

Authorization

ApiKeyAuth OrganizationId

X-API-Key<token>

Your RedRaven API key.

In: header

X-Organization-Id<token>

RedRaven organization UUID that scopes the API key.

In: header

Path Parameters

test_id*string

RedRaven test UUID.

Formatuuid

Query Parameters

limit?integer

Maximum rows to return. Use 0 to export all stored recommendations.

Default10

sort?string

Default"pass_rate_asc"

Value in

"pass_rate_asc"
"pass_rate_desc"

Response Body

`application/json`

curl -X GET "https://example.com/tests/497f6eca-6276-4993-bfeb-53cbbbba6f08/recommendations"

{  "recommendations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "redraven_policy_id": "string",      "redraven_policy_text": "string",      "certification": "string",      "pass_rate": 0,      "test_cases_total": 0,      "test_cases_failed": 0,      "fireguard_policy": {        "name": "string",        "description": "string",        "criticality": "LOW",        "violation": true,        "metadata": {}      },      "created_at": "2019-08-24T14:15:22Z"    }  ],  "count": 0}