RedRavenApi reference

Generate scenarios

Trigger scenario generation. Requires test policies and evaluated reconnaissance results. Poll the test until `metadata.scenarios.status` is `ready`.

POST
/tests/{test_id}/scenarios/generate

Trigger scenario generation. Requires test policies and evaluated reconnaissance results. Poll the test until metadata.scenarios.status is ready.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/tests/497f6eca-6276-4993-bfeb-53cbbbba6f08/scenarios/generate" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "string",  "test_id": "22e96a18-23fe-4c06-8ee6-180390ceaded"}
Empty

Evaluate reconnaissance responses POST

Submit target responses for each probe. `is_answered` true means the probe was answered (a fail). Results are stored on the test and are required before scenario generation.

Save scenarios PATCH

Replace scenario items. Each item is an attack purpose bound to one policy. Set `enabled` to false to skip an item at run time. `maximum_multi_turn` is 1–15 (default 5).