RunReveal

ManagedDetectionFacets returns the disjunctive filter-menu aggregates (severity/type/category/sourceType counts) for the managed-detection catalog, given the current filter context.

ManagedDetectionFacets returns the disjunctive filter-menu aggregates (severity/type/category/sourceType counts) for the managed-detection catalog, given the current filter context.

GET
/managed-detections/facets

Query Parameters

categoryarray<string>

categoryModestring

searchstring

severityarray<string>

severityModestring

sortstring

sourceScopearray<string>

sourceTypearray<string>

sourceTypeModestring

subscribedstring

typearray<string>

typeModestring

curl -X GET "https://api.runreveal.com/managed-detections/facets?category=string&categoryMode=string&search=string&severity=string&severityMode=string&sort=string&sourceScope=string&sourceType=string&sourceTypeMode=string&subscribed=string&type=string&typeMode=string"

Success

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

ManagedDetectionGet retrieves a managed detection from the detection library by name.

ManagedDetectionGet retrieves a managed detection from the detection library by name.

GET
/managed-detections/get
curl -X GET "https://api.runreveal.com/managed-detections/get?name=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "autoInvestigate": true,
    "autoTriage": true,
    "categories": [
      "string"
    ],
    "createdAt": {},
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "fields": [
      "string"
    ],
    "id": "string",
    "inlineTemplate": {
      "body": "string",
      "title": "string"
    },
    "mitreAttacks": [
      "string"
    ],
    "mitreTechniques": [
      "string"
    ],
    "name": "string",
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "query": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "severity": "string",
    "sourceTypes": [
      "string"
    ],
    "type": "string",
    "updatedAt": {}
  },
  "success": true
}

ManagedDetectionList returns a paginated list of managed detections from the detection library, with server-side filtering, sorting, and keyset pagination.

ManagedDetectionList returns a paginated list of managed detections from the detection library, with server-side filtering, sorting, and keyset pagination.

GET
/managed-detections/list

Query Parameters

categoryarray<string>

categoryModestring

searchstring

severityarray<string>

severityModestring

sortstring

sourceScopearray<string>

sourceTypearray<string>

sourceTypeModestring

subscribedstring

typearray<string>

typeModestring

curl -X GET "https://api.runreveal.com/managed-detections/list?category=string&categoryMode=string&search=string&severity=string&severityMode=string&sort=string&sourceScope=string&sourceType=string&sourceTypeMode=string&subscribed=string&type=string&typeMode=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "autoInvestigate": true,
      "autoTriage": true,
      "categories": [
        "string"
      ],
      "createdAt": {},
      "createdFrom": "string",
      "description": "string",
      "displayName": "string",
      "fields": [
        "string"
      ],
      "id": "string",
      "inlineTemplate": {
        "body": "string",
        "title": "string"
      },
      "mitreAttacks": [
        "string"
      ],
      "mitreTechniques": [
        "string"
      ],
      "name": "string",
      "notes": "string",
      "notificationNames": [
        "string"
      ],
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "query": "string",
      "riskScore": 0,
      "schedule": "string",
      "settings": [
        0
      ],
      "severity": "string",
      "sourceTypes": [
        "string"
      ],
      "type": "string",
      "updatedAt": {}
    }
  ],
  "success": true
}

ManagedDetectionBulkClone operation

POST
/managed-detections/subscriptions/bulk-clone

Request Body

application/jsonRequired

detectionIDsarray<string>

curl -X POST "https://api.runreveal.com/managed-detections/subscriptions/bulk-clone" \
  -H "Content-Type: application/json" \
  -d '{
    "detectionIDs": [
      "string"
    ]
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "agentConfigIdOrName": "string",
      "autoInvestigate": true,
      "autoTriage": true,
      "categories": [
        "string"
      ],
      "createdAt": {},
      "createdBy": "string",
      "createdFrom": "string",
      "description": "string",
      "displayName": "string",
      "enabled": true,
      "fields": [
        "string"
      ],
      "groupAlerts": true,
      "id": "string",
      "inlineTemplate": {
        "body": "string",
        "title": "string"
      },
      "managed": true,
      "mitreAttacks": [
        "string"
      ],
      "mitreTechniques": [
        "string"
      ],
      "name": "string",
      "nextRunTime": {},
      "notes": "string",
      "notificationNames": [
        "string"
      ],
      "notificationTemplate": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "public": true,
      "query": "string",
      "riskScore": 0,
      "schedule": "string",
      "settings": [
        0
      ],
      "severity": "string",
      "silencedUntil": {},
      "sourceTypes": [
        "string"
      ],
      "system": true,
      "type": "string",
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

ManagedDetectionBulkSubscribe operation

POST
/managed-detections/subscriptions/bulk-create

Request Body

application/jsonRequired

subscriptionsarray<object>

curl -X POST "https://api.runreveal.com/managed-detections/subscriptions/bulk-create" \
  -H "Content-Type: application/json" \
  -d '{
    "subscriptions": [
      {
        "agentConfigIdOrName": "string",
        "autoInvestigate": true,
        "autoTriage": true,
        "disabled": true,
        "groupAlerts": true,
        "managedDetectionConfigID": "string",
        "notificationNames": [
          "string"
        ],
        "notificationTemplate": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "type": "string"
      }
    ]
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "agentConfigIdOrName": "string",
      "autoInvestigate": true,
      "autoTriage": true,
      "categories": [
        "string"
      ],
      "createdAt": {},
      "createdBy": "string",
      "createdFrom": "string",
      "description": "string",
      "displayName": "string",
      "enabled": true,
      "fields": [
        "string"
      ],
      "groupAlerts": true,
      "id": "string",
      "inlineTemplate": {
        "body": "string",
        "title": "string"
      },
      "managed": true,
      "mitreAttacks": [
        "string"
      ],
      "mitreTechniques": [
        "string"
      ],
      "name": "string",
      "nextRunTime": {},
      "notes": "string",
      "notificationNames": [
        "string"
      ],
      "notificationTemplate": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "public": true,
      "query": "string",
      "riskScore": 0,
      "schedule": "string",
      "settings": [
        0
      ],
      "severity": "string",
      "silencedUntil": {},
      "sourceTypes": [
        "string"
      ],
      "system": true,
      "type": "string",
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

ManagedDetectionBulkUnsubscribe operation

DELETE
/managed-detections/subscriptions/bulk-delete

Query Parameters

idsarray<string>

typearray<string>

curl -X DELETE "https://api.runreveal.com/managed-detections/subscriptions/bulk-delete?ids=string&type=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "agentConfigIdOrName": "string",
      "autoInvestigate": true,
      "autoTriage": true,
      "categories": [
        "string"
      ],
      "createdAt": {},
      "createdBy": "string",
      "createdFrom": "string",
      "description": "string",
      "displayName": "string",
      "enabled": true,
      "fields": [
        "string"
      ],
      "groupAlerts": true,
      "id": "string",
      "inlineTemplate": {
        "body": "string",
        "title": "string"
      },
      "managed": true,
      "mitreAttacks": [
        "string"
      ],
      "mitreTechniques": [
        "string"
      ],
      "name": "string",
      "nextRunTime": {},
      "notes": "string",
      "notificationNames": [
        "string"
      ],
      "notificationTemplate": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "public": true,
      "query": "string",
      "riskScore": 0,
      "schedule": "string",
      "settings": [
        0
      ],
      "severity": "string",
      "silencedUntil": {},
      "sourceTypes": [
        "string"
      ],
      "system": true,
      "type": "string",
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

ManagedDetectionClone operation

GET
/managed-detections/subscriptions/clone

Query Parameters

detectionIDstring

subscriptionIDstring

curl -X GET "https://api.runreveal.com/managed-detections/subscriptions/clone?detectionID=string&subscriptionID=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "categories": [
      "string"
    ],
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "enabled": true,
    "fields": [
      "string"
    ],
    "groupAlerts": true,
    "id": "string",
    "inlineTemplate": {
      "body": "string",
      "title": "string"
    },
    "managed": true,
    "mitreAttacks": [
      "string"
    ],
    "mitreTechniques": [
      "string"
    ],
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "public": true,
    "query": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "severity": "string",
    "silencedUntil": {},
    "sourceTypes": [
      "string"
    ],
    "system": true,
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

ManagedDetectionSubscribe operation

POST
/managed-detections/subscriptions/create

Request Body

application/jsonRequired

agentConfigIdOrNamestring

autoInvestigateboolean

autoTriageboolean

disabledboolean

groupAlertsboolean

managedDetectionConfigIDstring

notificationNamesarray<string>

notificationTemplatestring

parametersobject

typestring

curl -X POST "https://api.runreveal.com/managed-detections/subscriptions/create" \
  -H "Content-Type: application/json" \
  -d '{
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "disabled": true,
    "groupAlerts": true,
    "managedDetectionConfigID": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "type": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "categories": [
      "string"
    ],
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "enabled": true,
    "fields": [
      "string"
    ],
    "groupAlerts": true,
    "id": "string",
    "inlineTemplate": {
      "body": "string",
      "title": "string"
    },
    "managed": true,
    "mitreAttacks": [
      "string"
    ],
    "mitreTechniques": [
      "string"
    ],
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "public": true,
    "query": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "severity": "string",
    "silencedUntil": {},
    "sourceTypes": [
      "string"
    ],
    "system": true,
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

ManagedDetectionUnsubscribe operation

DELETE
/managed-detections/subscriptions/delete

Query Parameters

idstring

typearray<string>

curl -X DELETE "https://api.runreveal.com/managed-detections/subscriptions/delete?id=string&type=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "agentConfigIdOrName": "string",
      "autoInvestigate": true,
      "autoTriage": true,
      "categories": [
        "string"
      ],
      "createdAt": {},
      "createdBy": "string",
      "createdFrom": "string",
      "description": "string",
      "displayName": "string",
      "enabled": true,
      "fields": [
        "string"
      ],
      "groupAlerts": true,
      "id": "string",
      "inlineTemplate": {
        "body": "string",
        "title": "string"
      },
      "managed": true,
      "mitreAttacks": [
        "string"
      ],
      "mitreTechniques": [
        "string"
      ],
      "name": "string",
      "nextRunTime": {},
      "notes": "string",
      "notificationNames": [
        "string"
      ],
      "notificationTemplate": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "public": true,
      "query": "string",
      "riskScore": 0,
      "schedule": "string",
      "settings": [
        0
      ],
      "severity": "string",
      "silencedUntil": {},
      "sourceTypes": [
        "string"
      ],
      "system": true,
      "type": "string",
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

ManagedDetectionSubscriptionUpdateEnabled operation

POST
/managed-detections/subscriptions/enabled/update

Request Body

application/jsonRequired

detectionstring

enabledboolean

curl -X POST "https://api.runreveal.com/managed-detections/subscriptions/enabled/update" \
  -H "Content-Type: application/json" \
  -d '{
    "detection": "string",
    "enabled": true
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "categories": [
      "string"
    ],
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "enabled": true,
    "fields": [
      "string"
    ],
    "groupAlerts": true,
    "id": "string",
    "inlineTemplate": {
      "body": "string",
      "title": "string"
    },
    "managed": true,
    "mitreAttacks": [
      "string"
    ],
    "mitreTechniques": [
      "string"
    ],
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "public": true,
    "query": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "severity": "string",
    "silencedUntil": {},
    "sourceTypes": [
      "string"
    ],
    "system": true,
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

ManagedDetectionSubscriptionGet operation

GET
/managed-detections/subscriptions/get
curl -X GET "https://api.runreveal.com/managed-detections/subscriptions/get?name=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "categories": [
      "string"
    ],
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "enabled": true,
    "fields": [
      "string"
    ],
    "groupAlerts": true,
    "id": "string",
    "inlineTemplate": {
      "body": "string",
      "title": "string"
    },
    "managed": true,
    "mitreAttacks": [
      "string"
    ],
    "mitreTechniques": [
      "string"
    ],
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "public": true,
    "query": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "severity": "string",
    "silencedUntil": {},
    "sourceTypes": [
      "string"
    ],
    "system": true,
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

ManagedDetectionSubscriptionList operation

GET
/managed-detections/subscriptions/list

Query Parameters

typearray<string>

curl -X GET "https://api.runreveal.com/managed-detections/subscriptions/list?type=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "agentConfigIdOrName": "string",
      "autoInvestigate": true,
      "autoTriage": true,
      "categories": [
        "string"
      ],
      "createdAt": {},
      "createdBy": "string",
      "createdFrom": "string",
      "description": "string",
      "displayName": "string",
      "enabled": true,
      "fields": [
        "string"
      ],
      "groupAlerts": true,
      "id": "string",
      "inlineTemplate": {
        "body": "string",
        "title": "string"
      },
      "managed": true,
      "mitreAttacks": [
        "string"
      ],
      "mitreTechniques": [
        "string"
      ],
      "name": "string",
      "nextRunTime": {},
      "notes": "string",
      "notificationNames": [
        "string"
      ],
      "notificationTemplate": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "public": true,
      "query": "string",
      "riskScore": 0,
      "schedule": "string",
      "settings": [
        0
      ],
      "severity": "string",
      "silencedUntil": {},
      "sourceTypes": [
        "string"
      ],
      "system": true,
      "type": "string",
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

ManagedDetectionSubscriptionSilenceUpdate operation

POST
/managed-detections/subscriptions/silence

Request Body

application/jsonRequired

detectionstring

silencedUntilobject

curl -X POST "https://api.runreveal.com/managed-detections/subscriptions/silence" \
  -H "Content-Type: application/json" \
  -d '{
    "detection": "string",
    "silencedUntil": {}
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "categories": [
      "string"
    ],
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "enabled": true,
    "fields": [
      "string"
    ],
    "groupAlerts": true,
    "id": "string",
    "inlineTemplate": {
      "body": "string",
      "title": "string"
    },
    "managed": true,
    "mitreAttacks": [
      "string"
    ],
    "mitreTechniques": [
      "string"
    ],
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "public": true,
    "query": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "severity": "string",
    "silencedUntil": {},
    "sourceTypes": [
      "string"
    ],
    "system": true,
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

ManagedDetectionSubscriptionUpdate operation

POST
/managed-detections/subscriptions/update

Request Body

application/jsonRequired

agentConfigIdOrNamestring

autoInvestigateboolean

autoTriageboolean

enabledboolean

groupAlertsboolean

idstring

notificationNamesarray<string>

notificationTemplatestring

parametersobject

curl -X POST "https://api.runreveal.com/managed-detections/subscriptions/update" \
  -H "Content-Type: application/json" \
  -d '{
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "enabled": true,
    "groupAlerts": true,
    "id": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    }
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "agentConfigIdOrName": "string",
    "autoInvestigate": true,
    "autoTriage": true,
    "categories": [
      "string"
    ],
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "enabled": true,
    "fields": [
      "string"
    ],
    "groupAlerts": true,
    "id": "string",
    "inlineTemplate": {
      "body": "string",
      "title": "string"
    },
    "managed": true,
    "mitreAttacks": [
      "string"
    ],
    "mitreTechniques": [
      "string"
    ],
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "public": true,
    "query": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "severity": "string",
    "silencedUntil": {},
    "sourceTypes": [
      "string"
    ],
    "system": true,
    "type": "string",
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}