get_controls
Retrieve implementation controls for a threat model to satisfy its control objectives. Filter by status, component, or control ID; optionally include orphaned controls.
Instructions
Get implementation controls for a threat model.
Returns the controls that should be implemented to satisfy the model's
control objectives. Mostly read-only, with one side effect: if
controls have never been generated for this model, the first call
triggers generation. Generation may finish inline or continue in the
background — if results look incomplete, poll
get_control_generation_status and re-read once it reports
complete.
By default excludes ORPHANED controls (controls whose every mapped CO
is tombstoned because its asset/attacker pair was removed in a later
version). Pass include_orphaned=True to include them; each
returned control carries a boolean orphaned field so callers can
render the distinction.
For one control's full detail pass control_id; for a lightweight
listing pass summary_only=True.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| co_id | No | Filter by control objective ID. | |
| limit | No | Max controls to return (0 = all). | |
| offset | No | Skip the first N controls (pagination). | |
| status | No | Filter by "implemented", "not_implemented", or "verified". | |
| model_id | Yes | ID of the threat model. | |
| control_id | No | Optional specific control id for detail mode. | |
| component_id | No | Filter by component ID (e.g., "CMP1"). | |
| summary_only | No | If True, returns only id, description, status, assertion_count, and assumed_by per control (much smaller response). | |
| server_version | Yes | ||
| include_deleted | No | Include soft-deleted controls (default False). | |
| include_orphaned | No | Include controls mapped only to tombstoned COs (default False). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||