Create a risk.

Authorization

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug*string

Match^[a-z0-9-]+$

Length1 <= length

name*string

Length2 <= length <= 255

ownerId*string

organizationId*string

treatmentType?string

Default"UNKNOWN"

Value in

"UNKNOWN"
"MITIGATE"
"ACCEPT"
"AVOID"
"TRANSFER"

description?|

Defaultnull

threatClassId?|

Defaultnull

vulnerabilityClassId?|

Defaultnull

impactDescription?|

Defaultnull

initialProbabilityRating?|null

initialImpactRating?|null

residualProbabilityRating?|null

residualImpactRating?|null

treatmentDescription?string

Default""

affectedParties?array<string>

Default[]

riskTreatments?array<string>

Default[]

controlLinks?array<string>

Default[]

labels?array<string>

Default[]

Response Body

`application/json`

curl -X POST "https://example.com/risks/" \  -H "Content-Type: application/json" \  -d '{    "slug": "string",    "name": "string",    "ownerId": "string",    "organizationId": "string"  }'

{  "id": "string",  "shortId": -9007199254740991,  "slug": "string",  "name": "string",  "ownerId": "string",  "description": "string",  "createdAt": "string",  "updatedAt": "string",  "archivedAt": "string",  "organizationId": "string",  "threatClassId": "string",  "vulnerabilityClassId": "string",  "impactDescription": "string",  "initialProbabilityRating": 0,  "initialImpactRating": 0,  "residualProbabilityRating": 0,  "residualImpactRating": 0,  "treatmentType": "UNKNOWN",  "treatmentDescription": "string"}

How is this guide?

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`