Riscly docs

API reference

Projects

A project is a unit of analysis — usually one repository or app. It owns connections, scans, business context and the architecture overlay.

List projects

GET/api/projects
curl https://api.riscly.com/api/projects \
  -H "Authorization: Bearer $RISCLY_TOKEN" \
  -H "x-org-id: $RISCLY_ORG_ID"

Create a project

POST/api/projects
FieldTypeDescription
namerequiredstringDisplay name, often the repo it will be attached to.
curl -X POST https://api.riscly.com/api/projects \
  -H "Authorization: Bearer $RISCLY_TOKEN" \
  -H "x-org-id: $RISCLY_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"my-app"}'

Rename a project

PATCH/api/projects/{projectId}
curl -X PATCH https://api.riscly.com/api/projects/PROJECT_ID \
  -H "Authorization: Bearer $RISCLY_TOKEN" \
  -H "x-org-id: $RISCLY_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"renamed"}'

Files & commits

Browse the repo file tree and read individual files for the code explorer.

GET/api/projects/{projectId}/files?repo={repo}
GET/api/projects/{projectId}/files/content?repo={repo}&path={path}
GET/api/projects/{projectId}/commits?limit=8

Business context

Optional business context for API consumers that want to compute their own impact estimates (see Reliability & simulation). Not surfaced in the Riscly UI.

GET/api/projects/{projectId}/business
PUT/api/projects/{projectId}/business
FieldTypeDescription
monthlyRevenuerequirednumberMonthly recurring revenue.
activeUsersrequirednumberActive users in the period.
currencystringISO currency code, e.g. EUR.
peakCheckoutSharenumberShare of throughput at peak (0–1).

Architecture overlay

Your manual corrections to the auto-detected graph; persisted across scans.

GET/api/projects/{projectId}/architecture-overlay
PUT/api/projects/{projectId}/architecture-overlay
PreviousOverviewNext Scans