devguard

RisksId

Update a risk by id.

PATCH
/risks/{id}/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

shortId*integer
Range-9007199254740991 <= value <= 9007199254740991
slug*string
Match^[a-z0-9-]+$
Length1 <= length
name*string
Length2 <= length <= 255
ownerId*string
description?|
organizationId*string
threatClassId?|
vulnerabilityClassId?|
impactDescription?|
initialProbabilityRating*|
initialImpactRating*|
residualProbabilityRating*|
residualImpactRating*|
treatmentType?string
Default"UNKNOWN"
Value in"UNKNOWN" | "MITIGATE" | "ACCEPT" | "AVOID" | "TRANSFER"
treatmentDescription*string
affectedParties?array<>
Default[]
riskTreatments?array<>
Default[]
controlLinks?array<>
Default[]

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.devguard.ch/api/risks/string/" \  -H "Content-Type: application/json" \  -d '{    "shortId": -9007199254740991,    "slug": "string",    "name": "string",    "ownerId": "string",    "organizationId": "string",    "initialProbabilityRating": 10,    "initialImpactRating": 10,    "residualProbabilityRating": 10,    "residualImpactRating": 10,    "treatmentDescription": "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": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?