FIfirefly
Governance

Update an Insight

Updates an existing insight with the provided configuration. The endpoint validates required fields (name, code, type, providerIds, category) and tests the Rego code for validity before updating.

put/governance/insights/{id}

Request

Path parameters

idstring required

The ID of the insight to update

Request body

namestring required

Name of the insight

descriptionstring

Description of the insight

codestring required

Rego code for the insight rule (can be base64 encoded)

typestring[] required

Array of insight types

providerIdsstring[] required

Array of provider IDs this insight applies to

severityinteger

Severity level of the insight

categorystring required

Category of the insight

frameworksstring[]

Array of compliance frameworks this insight relates to

Example request

{
  "code": "ZmlyZWZseSB7CiAgICBtYXRjaAp9CgptYXRjaCB7CiAgICBpbnB1dC5iYXRjaF90YXJnZXQgPT0gInRlc3QiCn0=",
  "type": [
    "aws_cloudwatch_event_target"
  ],
  "providerIds": [
    "aws_all",
    "6616a2dbf4992fc0bab0463f"
  ],
  "labels": "security,compliance",
  "category": "Misconfiguration",
  "frameworks": [
    "SOC2",
    "ISO27001"
  ]
}

Response

Insight updated successfully

idstring

The ID of the updated insight

namestring

Name of the insight

descriptionstring

Description of the insight

codestring

Rego code for the insight rule

typestring[]

Array of insight types

providerIdsstring[]

Array of provider IDs

severitystring

Severity level

categorystring

Category

frameworksstring[]

Array of compliance frameworks

Example response

{
  "labels": "security,compliance"
}

Changes

No recorded changes to this operation across all 1 revision of this API.