Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

The Blast Radius API helps you understand how far a failure can spread — before it happens or while it is unfolding. Submit a trigger or service identifier and Scrubbe traverses the downstream dependency graph to estimate which services, regions, and user populations are at risk. Reports are persisted so you can track risk over time, compare assessments across incidents, and feed impact data into incident creation or playbook selection.
All endpoints require Authorization: Bearer <token>. Provide either triggerId or serviceId in the calculate request body — not both.
Base path: https://your-api-domain.com/api/v1/blast-radius

​
Calculate blast radius

Trigger a blast radius calculation for a given trigger or service. Scrubbe traverses the dependency graph and returns an impact assessment covering affected services, estimated user population, and risk scores. POST https://your-api-domain.com/api/v1/blast-radius/calculate
​
triggerId
string
ID of the event or alert trigger to calculate impact for. Provide either triggerId or serviceId.
​
serviceId
string
ID of the service to model as the failure origin. Provide either triggerId or serviceId.
​
environment
string
Constrain the calculation to a specific environment (e.g. "production", "staging").
​
depth
number
default:"3"
Maximum dependency traversal depth. Higher values are more thorough but take longer to compute.
curl -X POST https://your-api-domain.com/api/v1/blast-radius/calculate \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "triggerId": "TRG-20260522-0041",
    "environment": "production"
  }'
​
reportId
string
required
Unique identifier for this blast radius report.
​
triggerId
string
Trigger ID used as the calculation origin, if provided.
​
serviceId
string
Service ID used as the calculation origin, if provided.
​
environment
string
Environment the calculation was scoped to.
​
affectedServices
object[]
Services within the blast radius, ordered by risk score descending.
​
estimatedUserImpact
string
Plain-language description of the estimated affected user population.
​
overallRiskScore
number
Aggregate risk score for the entire blast radius, from 0 to 1.
​
calculatedAt
string
required
ISO 8601 timestamp of the calculation.
Run a blast radius calculation at the start of a major incident to quickly populate the blastRadius field on the incident ticket and inform stakeholder communications.

​
List blast radius reports

Returns a paginated list of all blast radius reports for the workspace, ordered by calculation date descending. GET https://your-api-domain.com/api/v1/blast-radius
​
page
number
default:"1"
Page number.
​
limit
number
default:"20"
Items per page (max 100).
​
serviceId
string
Filter reports by origin service.
​
environment
string
Filter by environment.
cURL
curl "https://your-api-domain.com/api/v1/blast-radius?serviceId=svc-payments" \
  -H "Authorization: Bearer <token>"
​
data
object[]
Array of blast radius report summaries.
​
total
number
Total matching report count.

​
Get risk summary

Returns an aggregated risk summary across all services in the workspace — overall risk distribution, top highest-risk services, and trend data. Use this for dashboard widgets and reliability reviews. GET https://your-api-domain.com/api/v1/blast-radius/risk-summary
cURL
curl https://your-api-domain.com/api/v1/blast-radius/risk-summary \
  -H "Authorization: Bearer <token>"
​
totalServicesAnalysed
number
Number of services with at least one blast radius report.
​
highRiskServices
object[]
Services with an average risk score above 0.75, ordered by score descending.
​
riskDistribution
object
Count of services by risk tier.
​
lastUpdated
string
ISO 8601 timestamp of the most recent calculation included in the summary.

​
Get reports for a trigger

Returns all blast radius reports associated with a specific trigger ID. GET https://your-api-domain.com/api/v1/blast-radius/trigger/:triggerId
​
triggerId
string
required
The trigger ID.
cURL
curl https://your-api-domain.com/api/v1/blast-radius/trigger/TRG-20260522-0041 \
  -H "Authorization: Bearer <token>"
​
data
object[]
Array of blast radius reports linked to the given trigger.

​
Get a report by ID

Returns the full detail for a single blast radius report, including all affected services and risk scores. GET https://your-api-domain.com/api/v1/blast-radius/:id
​
id
string
required
The blast radius report ID.
cURL
curl https://your-api-domain.com/api/v1/blast-radius/BR-20260522-0018 \
  -H "Authorization: Bearer <token>"
​
reportId
string
required
Unique report identifier.
​
triggerId
string
Trigger origin, if the report was calculated from a trigger.
​
serviceId
string
Service origin, if the report was calculated from a service.
​
environment
string
Scoped environment.
​
affectedServices
object[]
Services within the blast radius, ordered by risk score.
​
estimatedUserImpact
string
Plain-language estimate of affected users.
​
overallRiskScore
number
Aggregate risk score, from 0 to 1.
​
calculatedAt
string
required
ISO 8601 timestamp of the calculation.