Skip to main content
For AI agents: a documentation index is available at https://docs.coverbase.com/llms.txt — this page is also available in markdown by appending .md to the URL.
A reassessment (cbrsm_...) is a draft batch of assessments to run against a set of vendors — typically prompted by a radar event or alert. It lets you curate the vendor set and choose an assessment plan, then run it, without ever opening a case. A reassessment moves through four statuses: A reassessment in a terminal status (run or dismissed) is immutable. All endpoints are org-scoped to the API key. See API conventions for shared behavior. None of these honor Idempotency-Key.

​
Create a reassessment

​
POST
POST /v1/reassessments
Returns 201 Created. Creates a draft reassessment from a radar event with an initial vendor set. The assessment plan is optional up front — set it later with a PATCH before running.

​
Request body

​
string
required
The radar event providing context for the reassessment (cbrevent_...).
​
string[]
required
Vendors to include (cbvndr_...). At least one; all must belong to the API key’s org.
​
string
Assessment plan to run (cbasmtpl_...). Optional; set later before running.
​
string
Reassessment title.

​
Example request

cURL
Returns the reassessment object.

​
Reassessment object

​
string
Reassessment ID (cbrsm_...).
​
string
draft, confirmed, run, or dismissed.
​
string | null
Title.
​
string | null
Linked assessment plan (cbasmtpl_...).
​
string | null
Source radar event (cbrevent_...).
​
string[]
Radar alerts that drove the reassessment.
​
object[]
Per-vendor entries — see below.
​
integer
Unix timestamp (seconds).
​
integer
Unix timestamp (seconds).
Each vendors[] entry:
​
string
Vendor (cbvndr_...).
​
string
How the vendor joined: matched (added at creation) or manual (added during review).
​
boolean
Whether the vendor is in the run set.
​
string | null
Assessment created for this vendor once the reassessment is run.

​
List reassessments

​
GET
GET /v1/reassessments

​
Query parameters

​
string
Filter by status (draft, confirmed, run, dismissed).
Returns an items array of reassessment objects, newest first.

​
Retrieve a reassessment

​
GET
GET /v1/reassessments/{reassessment_id}
Returns the reassessment object, or 404 reassessment_not_found.

​
Update a reassessment

​
PATCH
PATCH /v1/reassessments/{reassessment_id}
Update editable metadata. Only included fields change. Rejected with 422 reassessment_immutable once the reassessment is run or dismissed.

​
Request body

​
string
New title.
​
string
Assessment plan to run (cbasmtpl_...).
​
string
Re-link to a different radar event (cbrevent_...).

​
Curate the vendor set

​
POST
POST /v1/reassessments/{reassessment_id}/vendors
Add manually-selected vendors. Body: { "vendor_ids": ["cbvndr_..."] } (at least one).
​
POST
POST /v1/reassessments/{reassessment_id}/vendor_inclusion
Opt a single vendor in or out of the run set. Body: { "vendor_id": "cbvndr_...", "included": false }. Both return the refreshed reassessment object.

​
Confirm, dismiss, run

​
POST
POST /v1/reassessments/{reassessment_id}/confirm
Move a draft reassessment to confirmed (vendor set locked in, ready to run).
​
POST
POST /v1/reassessments/{reassessment_id}/dismiss
Close a reassessment without running it (dismissed).
​
POST
POST /v1/reassessments/{reassessment_id}/run
Create an assessment from the linked plan for each included vendor, then mark the reassessment run. Requires assessment_plan_id to be set first — otherwise 400 missing_assessment_plan. This never creates a case.

​
Example request

cURL
All three return the refreshed reassessment object.

​
Error responses

  • Radar API — the events and alerts that prompt reassessments.
  • Webhooks — subscribe to Reassessment.* events.