devguard

Risks

Create a risk.

POST
/risks/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

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?|
initialImpactRating?|
residualProbabilityRating?|
residualImpactRating?|
treatmentDescription?string
Default""
affectedParties?array<>
Default[]
riskTreatments?array<>
Default[]
controlLinks?array<>
Default[]

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.devguard.ch/api/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",
  "organizationId": "string",
  "threatClassId": "string",
  "vulnerabilityClassId": "string",
  "impactDescription": "string",
  "initialProbabilityRating": 10,
  "initialImpactRating": 10,
  "residualProbabilityRating": 10,
  "residualImpactRating": 10,
  "treatmentType": "UNKNOWN",
  "treatmentDescription": "string"
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?