RunReveal

InvestigationsAlertStatus operation

POST
/investigations/alert-status

Request Body

application/jsonRequired

alertIDsarray<string>

scheduledRunIDsarray<string>

curl -X POST "https://api.runreveal.com/investigations/alert-status" \
  -H "Content-Type: application/json" \
  -d '{
    "alertIDs": [
      "string"
    ],
    "scheduledRunIDs": [
      "string"
    ]
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "alertStatus": {
      "property1": {
        "hasAIInvestigation": true,
        "hasInvestigation": true,
        "investigationID": "string",
        "name": "string",
        "status": "string"
      },
      "property2": {
        "hasAIInvestigation": true,
        "hasInvestigation": true,
        "investigationID": "string",
        "name": "string",
        "status": "string"
      }
    }
  },
  "success": true
}

InvestigationAddArtifact operation

POST
/investigations/artifact/add

Request Body

application/jsonRequired

commentstring

investigationIDstring

metaarray<integer>

typestring

curl -X POST "https://api.runreveal.com/investigations/artifact/add" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "string",
    "investigationID": "string",
    "meta": [
      0
    ],
    "type": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "comment": "string",
    "created_at": {},
    "created_by": "string",
    "id": "string",
    "investigation_id": "string",
    "meta": [
      0
    ],
    "starred": true,
    "type": "string",
    "updated_at": {},
    "workspace_id": "string"
  },
  "success": true
}

InvestigationArtifactData operation

GET
/investigations/artifact/data

Query Parameters

artifactIDstring

investigationIDstring

curl -X GET "https://api.runreveal.com/investigations/artifact/data?artifactID=string&investigationID=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    0
  ],
  "success": true
}

InvestigationArtifactDelete operation

DELETE
/investigations/artifact/delete

Query Parameters

artifactIDstring

investigationIDstring

curl -X DELETE "https://api.runreveal.com/investigations/artifact/delete?artifactID=string&investigationID=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

InvestigationArtifactList lists the artifacts for an investigation.

InvestigationArtifactList lists the artifacts for an investigation.

GET
/investigations/artifact/list

Query Parameters

investigationIDstring

lastReadIDstring

curl -X GET "https://api.runreveal.com/investigations/artifact/list?investigationID=string&lastReadID=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "comment": "string",
      "created_at": {},
      "created_by": "string",
      "id": "string",
      "investigation_id": "string",
      "meta": [
        0
      ],
      "starred": true,
      "type": "string",
      "updated_at": {},
      "workspace_id": "string"
    }
  ],
  "success": true
}

InvestigationStarArtifact operation

POST
/investigations/artifact/star

Request Body

application/jsonRequired

artifactIDstring

investigationIDstring

starredboolean

curl -X POST "https://api.runreveal.com/investigations/artifact/star" \
  -H "Content-Type: application/json" \
  -d '{
    "artifactID": "string",
    "investigationID": "string",
    "starred": true
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "comment": "string",
    "created_at": {},
    "created_by": "string",
    "id": "string",
    "investigation_id": "string",
    "meta": [
      0
    ],
    "starred": true,
    "type": "string",
    "updated_at": {},
    "workspace_id": "string"
  },
  "success": true
}

InvestigationBulkClose closes multiple investigations by ID in a single request, applying the same resolution note and classification to each one. Every closed investigation gets its own resolution artifact, so the close appears in each timeline just as it does when closing one at a time. The batch is atomic: if any investigation fails to close, none of them do.

InvestigationBulkClose closes multiple investigations by ID in a single request, applying the same resolution note and classification to each one. Every closed investigation gets its own resolution artifact, so the close appears in each timeline just as it does when closing one at a time. The batch is atomic: if any investigation fails to close, none of them do.

POST
/investigations/bulk-close

Request Body

application/jsonRequired

classificationstring

idsarray<string>

resolutionstring

curl -X POST "https://api.runreveal.com/investigations/bulk-close" \
  -H "Content-Type: application/json" \
  -d '{
    "classification": "string",
    "ids": [
      "string"
    ],
    "resolution": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

InvestigationsByAlert returns the investigations associated with an alert, including AI summaries when available.

InvestigationsByAlert returns the investigations associated with an alert, including AI summaries when available.

GET
/investigations/by-alert

Query Parameters

alertIDstring

curl -X GET "https://api.runreveal.com/investigations/by-alert?alertID=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "investigations": [
      {
        "aiSummary": "string",
        "chatID": "string",
        "investigation": {
          "assignee": "string",
          "classification": "string",
          "created_at": {},
          "created_by": "string",
          "created_by_type": "string",
          "description": "string",
          "detected_at": {},
          "id": "string",
          "name": "string",
          "resolved_at": {},
          "responded_at": {},
          "severity": "string",
          "status": "string",
          "summary": "string",
          "tags": [
            "string"
          ],
          "title": "string",
          "triaged_at": {},
          "updated_at": {},
          "workspace_id": "string"
        }
      }
    ]
  },
  "success": true
}

InvestigationsByDetection returns the most recent investigations created by a specific detection.

InvestigationsByDetection returns the most recent investigations created by a specific detection.

GET
/investigations/by-detection

Query Parameters

detectionNamestring

fromstring

limitinteger

tostring

curl -X GET "https://api.runreveal.com/investigations/by-detection?detectionName=string&from=string&limit=0&to=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "investigations": [
      {
        "assignee": "string",
        "classification": "string",
        "created_at": {},
        "created_by": "string",
        "created_by_type": "string",
        "description": "string",
        "detected_at": {},
        "id": "string",
        "name": "string",
        "resolved_at": {},
        "responded_at": {},
        "severity": "string",
        "status": "string",
        "summary": "string",
        "tags": [
          "string"
        ],
        "title": "string",
        "triaged_at": {},
        "updated_at": {},
        "workspace_id": "string"
      }
    ]
  },
  "success": true
}

InvestigationClose closes an investigation with a resolution comment and optional classification.

InvestigationClose closes an investigation with a resolution comment and optional classification.

POST
/investigations/close

Request Body

application/jsonRequired

classificationstring

investigationIDstring

resolutionstring

curl -X POST "https://api.runreveal.com/investigations/close" \
  -H "Content-Type: application/json" \
  -d '{
    "classification": "string",
    "investigationID": "string",
    "resolution": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

InvestigationCreate creates a new investigation in the workspace.

InvestigationCreate creates a new investigation in the workspace.

POST
/investigations/create

Request Body

application/jsonRequired

descriptionstring

severitystring

statusstring

tagsarray<string>

titlestring

curl -X POST "https://api.runreveal.com/investigations/create" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "severity": "string",
    "status": "string",
    "tags": [
      "string"
    ],
    "title": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "assignee": "string",
    "classification": "string",
    "created_at": {},
    "created_by": "string",
    "created_by_type": "string",
    "description": "string",
    "detected_at": {},
    "id": "string",
    "name": "string",
    "resolved_at": {},
    "responded_at": {},
    "severity": "string",
    "status": "string",
    "summary": "string",
    "tags": [
      "string"
    ],
    "title": "string",
    "triaged_at": {},
    "updated_at": {},
    "workspace_id": "string"
  },
  "success": true
}

InvestigationDelete deletes an investigation by ID.

InvestigationDelete deletes an investigation by ID.

DELETE
/investigations/delete
curl -X DELETE "https://api.runreveal.com/investigations/delete?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "id": "string"
  },
  "success": true
}

InvestigationFacets returns the disjunctive filter-menu aggregates (status/severity/classification/createdByType/tags/createdBy counts) for the workspace investigations list, given the current filter context.

InvestigationFacets returns the disjunctive filter-menu aggregates (status/severity/classification/createdByType/tags/createdBy counts) for the workspace investigations list, given the current filter context.

GET
/investigations/facets

Query Parameters

assigneearray<string>

assigneeModestring

classificationarray<string>

classificationModestring

createdByarray<string>

createdByModestring

createdByTypearray<string>

createdByTypeModestring

fromstring

searchstring

severityarray<string>

severityModestring

sortstring

statusarray<string>

statusModestring

tagsarray<string>

tagsModestring

tostring

curl -X GET "https://api.runreveal.com/investigations/facets?assignee=string&assigneeMode=string&classification=string&classificationMode=string&createdBy=string&createdByMode=string&createdByType=string&createdByTypeMode=string&from=string&search=string&severity=string&severityMode=string&sort=string&status=string&statusMode=string&tags=string&tagsMode=string&to=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "buckets": {
      "property1": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ],
      "property2": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ]
    }
  },
  "success": true
}

InvestigationGet returns an investigation along with its artifacts and timing metrics.

InvestigationGet returns an investigation along with its artifacts and timing metrics.

GET
/investigations/get
curl -X GET "https://api.runreveal.com/investigations/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "artifacts": [
      {
        "comment": "string",
        "created_at": {},
        "created_by": "string",
        "id": "string",
        "investigation_id": "string",
        "meta": [
          0
        ],
        "starred": true,
        "type": "string",
        "updated_at": {},
        "workspace_id": "string"
      }
    ],
    "investigation": {
      "assignee": "string",
      "classification": "string",
      "created_at": {},
      "created_by": "string",
      "created_by_type": "string",
      "description": "string",
      "detected_at": {},
      "id": "string",
      "name": "string",
      "resolved_at": {},
      "responded_at": {},
      "severity": "string",
      "status": "string",
      "summary": "string",
      "tags": [
        "string"
      ],
      "title": "string",
      "triaged_at": {},
      "updated_at": {},
      "workspace_id": "string"
    },
    "metrics": {
      "detectSeconds": 0,
      "investigateSeconds": 0,
      "resolveSeconds": 0,
      "respondSeconds": 0
    }
  },
  "success": true
}

InvestigationIocLookup searches for indicators of compromise across all investigations in a workspace.

InvestigationIocLookup searches for indicators of compromise across all investigations in a workspace.

GET
/investigations/ioc/lookup

Query Parameters

classificationstring

iocTypestring

iocValuestring

curl -X GET "https://api.runreveal.com/investigations/ioc/lookup?classification=string&iocType=string&iocValue=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "artifactID": "string",
      "classification": "string",
      "createdAt": {},
      "investigationID": "string",
      "investigationTitle": "string",
      "iocType": "string",
      "iocValue": "string",
      "severity": "string",
      "status": "string"
    }
  ],
  "success": true
}

InvestigationList returns all investigation configs for a workspace

InvestigationList returns all investigation configs for a workspace

GET
/investigations/list

Query Parameters

assigneearray<string>

assigneeModestring

classificationarray<string>

classificationModestring

createdByarray<string>

createdByModestring

createdByTypearray<string>

createdByTypeModestring

fromstring

searchstring

severityarray<string>

severityModestring

sortstring

statusarray<string>

statusModestring

tagsarray<string>

tagsModestring

tostring

curl -X GET "https://api.runreveal.com/investigations/list?assignee=string&assigneeMode=string&classification=string&classificationMode=string&createdBy=string&createdByMode=string&createdByType=string&createdByTypeMode=string&from=string&search=string&severity=string&severityMode=string&sort=string&status=string&statusMode=string&tags=string&tagsMode=string&to=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "assignee": "string",
      "classification": "string",
      "created_at": {},
      "created_by": "string",
      "created_by_type": "string",
      "description": "string",
      "detected_at": {},
      "id": "string",
      "name": "string",
      "resolved_at": {},
      "responded_at": {},
      "severity": "string",
      "status": "string",
      "summary": "string",
      "tags": [
        "string"
      ],
      "title": "string",
      "triaged_at": {},
      "updated_at": {},
      "workspace_id": "string"
    }
  ],
  "success": true
}

InvestigationMetrics returns aggregate SOC metrics across investigations.

InvestigationMetrics returns aggregate SOC metrics across investigations.

POST
/investigations/metrics

Request Body

application/jsonRequired

severitystring

sinceobject

untilobject

curl -X POST "https://api.runreveal.com/investigations/metrics" \
  -H "Content-Type: application/json" \
  -d '{
    "severity": "string",
    "since": {},
    "until": {}
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "classificationBreakdown": {
      "property1": 0,
      "property2": 0
    },
    "closedInvestigations": 0,
    "detect": {
      "mean": 0,
      "p50": 0,
      "p95": 0
    },
    "detectionStats": [
      {
        "aiTriaged": 0,
        "closed": 0,
        "detectionName": "string",
        "falsePositives": 0,
        "totalInvestigations": 0,
        "triagePending": 0
      }
    ],
    "falsePositiveRate": 0,
    "investigate": {
      "mean": 0,
      "p50": 0,
      "p95": 0
    },
    "resolve": {
      "mean": 0,
      "p50": 0,
      "p95": 0
    },
    "respond": {
      "mean": 0,
      "p50": 0,
      "p95": 0
    },
    "severityBreakdown": {
      "property1": 0,
      "property2": 0
    },
    "statusBreakdown": {
      "property1": 0,
      "property2": 0
    },
    "totalInvestigations": 0
  },
  "success": true
}

InvestigationTriageRetry manually triggers a retry for a failed triage

InvestigationTriageRetry manually triggers a retry for a failed triage

POST
/investigations/triage/retry

Request Body

application/jsonRequired

investigationIDstring

curl -X POST "https://api.runreveal.com/investigations/triage/retry" \
  -H "Content-Type: application/json" \
  -d '{
    "investigationID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "taskID": "string"
  },
  "success": true
}

InvestigationTriageStatus returns the triage status for an investigation

InvestigationTriageStatus returns the triage status for an investigation

GET
/investigations/triage/status

Query Parameters

investigationIDstring

curl -X GET "https://api.runreveal.com/investigations/triage/status?investigationID=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "agentName": "string",
    "chatID": "string",
    "completedAt": {},
    "createdAt": {},
    "error": "string",
    "hasTriage": true,
    "lastError": "string",
    "maxRetries": 0,
    "model": "string",
    "provider": "string",
    "retryCount": 0,
    "startedAt": {},
    "status": "string",
    "taskID": "string"
  },
  "success": true
}

InvestigationUpdate updates a single field of an investigation and records the change as an artifact.

InvestigationUpdate updates a single field of an investigation and records the change as an artifact.

PUT
/investigations/update

Request Body

application/jsonRequired

fieldstring

idstring

valuestring

curl -X PUT "https://api.runreveal.com/investigations/update" \
  -H "Content-Type: application/json" \
  -d '{
    "field": "string",
    "id": "string",
    "value": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "assignee": "string",
    "classification": "string",
    "created_at": {},
    "created_by": "string",
    "created_by_type": "string",
    "description": "string",
    "detected_at": {},
    "id": "string",
    "name": "string",
    "resolved_at": {},
    "responded_at": {},
    "severity": "string",
    "status": "string",
    "summary": "string",
    "tags": [
      "string"
    ],
    "title": "string",
    "triaged_at": {},
    "updated_at": {},
    "workspace_id": "string"
  },
  "success": true
}