Skip to main content

List Actions

Endpoint

GET /api/v1/mitigation-actions

Query Parameters

ParameterTypeDescription
bra_idUUIDFilter by BRA
statusstringcreated, in_progress, completed
prioritystringlow, medium, high, critical
overdue_onlybooleanShow only overdue actions
archivedbooleanInclude archived (default: false)
pageintegerPage number
page_sizeintegerItems per page

Response

{
  "data": [
    {
      "id": "ma-uuid-001",
      "action": "Implement MFA for all administrative access",
      "owner": "[email protected]",
      "status": "in_progress",
      "priority": "high",
      "due_date": "2026-03-31",
      "action_type": "Technology",
      "bra_id": "bra-uuid-001",
      "bra_risk_scenario_id": "brs-uuid-001",
      "is_overdue": false,
      "created_at": "2026-01-15T10:00:00Z",
      "bra": {
        "name": "Q1 2026 Assessment"
      },
      "risk_scenario": {
        "name": "Cyberattack Risk"
      }
    }
  ],
  "pagination": { ... }
}

Create Action

Endpoint

POST /api/v1/mitigation-actions

Request Body

{
  "action": "Implement MFA for all administrative access",
  "owner": "[email protected]",
  "priority": "high",
  "action_type": "Technology",
  "due_date": "2026-03-31",
  "bra_id": "bra-uuid-001",
  "bra_risk_scenario_id": "brs-uuid-001"
}
FieldTypeRequiredDescription
actionstringYesAction description
ownerstringYesResponsible person/team
prioritystringYeslow, medium, high, critical
action_typestringYesCategory of action
due_datedateYesTarget completion date
bra_idUUIDNoLink to BRA
bra_risk_scenario_idUUIDNoLink to specific scenario

Response

{
  "data": {
    "id": "ma-uuid-new",
    "action": "Implement MFA for all administrative access",
    "status": "created",
    "created_at": "2026-01-16T10:00:00Z"
  },
  "message": "Mitigation action created successfully"
}

Update Action

Endpoint

PATCH /api/v1/mitigation-actions/{action_id}

Request Body

{
  "status": "in_progress",
  "owner": "[email protected]",
  "due_date": "2026-04-15"
}

Response

{
  "data": {
    "id": "ma-uuid-001",
    "status": "in_progress",
    "owner": "[email protected]",
    "due_date": "2026-04-15",
    "updated_at": "2026-01-16T10:00:00Z"
  },
  "message": "Mitigation action updated successfully"
}

Bulk Update

Endpoint

POST /api/v1/mitigation-actions/bulk-update

Request Body

{
  "action_ids": ["ma-uuid-001", "ma-uuid-002", "ma-uuid-003"],
  "updates": {
    "status": "in_progress"
  }
}

Response

{
  "data": {
    "updated_count": 3,
    "updated_ids": ["ma-uuid-001", "ma-uuid-002", "ma-uuid-003"]
  },
  "message": "3 actions updated successfully"
}

Archive Action

Endpoint

POST /api/v1/mitigation-actions/{action_id}/archive

Response

{
  "message": "Mitigation action archived successfully"
}