Skip to main content

Risk Register API

Space-scoped risk register for tracking, categorizing, and linking risks to data products.

Endpoints Overview

MethodEndpointDescription
POST/catalog/spaces/{slug}/risk-registerCreate risk entry
GET/catalog/spaces/{slug}/risk-registerList risk entries
GET/catalog/spaces/{slug}/risk-register/heat-mapRisk heat map
GET/catalog/spaces/{slug}/risk-register/templatesRisk templates
GET/catalog/spaces/{slug}/risk-register/{id}Get risk entry
PUT/catalog/spaces/{slug}/risk-register/{id}Update risk entry
POST/catalog/spaces/{slug}/risk-register/{id}/link-productsLink products
DELETE/catalog/spaces/{slug}/risk-register/{id}/products/{pid}Unlink product

List Risk Entries

GET /catalog/spaces/{slug}/risk-register

Query Parameters

ParameterTypeDescription
categorystringFilter by risk category
statusstringFilter by status
tierstringFilter by risk tier
product_idUUIDFilter by linked product
limitintegerPage size (max 100)
offsetintegerPagination offset

Risk Heat Map

GET /catalog/spaces/{slug}/risk-register/heat-map

Returns aggregated risk data bucketed by likelihood and impact for heat map visualization.


Risk Templates

GET /catalog/spaces/{slug}/risk-register/templates

Returns pre-built risk category templates for quick risk creation.


Create Risk Entry

POST /catalog/spaces/{slug}/risk-register
{
"title": "Model drift in credit scoring",
"description": "Performance degradation detected",
"category": "model_performance",
"likelihood": "probable",
"impact": "high",
"mitigation_plan": "Monthly model retraining"
}

POST /catalog/spaces/{slug}/risk-register/{entry_id}/link-products
{
"product_ids": ["uuid-1", "uuid-2"]
}

DELETE /catalog/spaces/{slug}/risk-register/{entry_id}/products/{product_id}

Error Responses

StatusDescription
404Risk entry not found