UTMStack API (10.4.0)

Download OpenAPI specification:Download

logs-resource

getList

Authorizations:
(bearerAuthApiKeyAuth)

Responses

changeLevel

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
name
string
level
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "level": "string"
}

utm-visualization-resource

getAllUtmVisualizations

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmVisualizationCriteria)
required
object (Pageable)

Responses

updateUtmVisualization

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
description
string [ 0 .. 255 ] characters
eventType
string
createdDate
string <date-time>
modifiedDate
string <date-time>
userCreated
string
userModified
string
chartConfig
string
chartAction
string
systemOwner
boolean
idPattern
required
integer <int64>
chartType
string
Enum: "METRIC_CHART" "PIE_CHART" "GAUGE_CHART" "GOAL_CHART" "TABLE_CHART" "TAG_CLOUD_CHART" "HORIZONTAL_BAR_CHART" "VERTICAL_BAR_CHART" "LINE_CHART" "AREA_CHART" "HEATMAP_CHART" "COORDINATE_MAP_CHART" "LIST_CHART" "TEXT_CHART"
Array of objects (FilterType)
object (AggregationType)
object (UtmIndexPattern)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "eventType": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "userCreated": "string",
  • "userModified": "string",
  • "chartConfig": "string",
  • "chartAction": "string",
  • "systemOwner": true,
  • "idPattern": 0,
  • "chartType": "METRIC_CHART",
  • "filterType": [
    ],
  • "aggregationType": {
    },
  • "pattern": {
    }
}

createUtmVisualization

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
description
string [ 0 .. 255 ] characters
eventType
string
createdDate
string <date-time>
modifiedDate
string <date-time>
userCreated
string
userModified
string
chartConfig
string
chartAction
string
systemOwner
boolean
idPattern
required
integer <int64>
chartType
string
Enum: "METRIC_CHART" "PIE_CHART" "GAUGE_CHART" "GOAL_CHART" "TABLE_CHART" "TAG_CLOUD_CHART" "HORIZONTAL_BAR_CHART" "VERTICAL_BAR_CHART" "LINE_CHART" "AREA_CHART" "HEATMAP_CHART" "COORDINATE_MAP_CHART" "LIST_CHART" "TEXT_CHART"
Array of objects (FilterType)
object (AggregationType)
object (UtmIndexPattern)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "eventType": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "userCreated": "string",
  • "userModified": "string",
  • "chartConfig": "string",
  • "chartAction": "string",
  • "systemOwner": true,
  • "idPattern": 0,
  • "chartType": "METRIC_CHART",
  • "filterType": [
    ],
  • "aggregationType": {
    },
  • "pattern": {
    }
}

run

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
description
string [ 0 .. 255 ] characters
eventType
string
createdDate
string <date-time>
modifiedDate
string <date-time>
userCreated
string
userModified
string
chartConfig
string
chartAction
string
systemOwner
boolean
idPattern
required
integer <int64>
chartType
string
Enum: "METRIC_CHART" "PIE_CHART" "GAUGE_CHART" "GOAL_CHART" "TABLE_CHART" "TAG_CLOUD_CHART" "HORIZONTAL_BAR_CHART" "VERTICAL_BAR_CHART" "LINE_CHART" "AREA_CHART" "HEATMAP_CHART" "COORDINATE_MAP_CHART" "LIST_CHART" "TEXT_CHART"
Array of objects (FilterType)
object (AggregationType)
object (UtmIndexPattern)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "eventType": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "userCreated": "string",
  • "userModified": "string",
  • "chartConfig": "string",
  • "chartAction": "string",
  • "systemOwner": true,
  • "idPattern": 0,
  • "chartType": "METRIC_CHART",
  • "filterType": [
    ],
  • "aggregationType": {
    },
  • "pattern": {
    }
}

createBatchUtmVisualization

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array of objects (UtmVisualization)
override
boolean

Responses

Request samples

Content type
application/json
{
  • "visualizations": [
    ],
  • "override": true
}

getUtmVisualization

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmVisualization

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

bulkDelete

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
ids
required
Array of integers <int64> [ items <int64 > ]

Responses

utm-server-resource

getAllUtmServers

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmServerCriteria)
required
object (Pageable)

Responses

updateUtmServer

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
serverName
string
serverType
string
Array of objects (UtmModule) unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "serverName": "string",
  • "serverType": "string",
  • "modules": [
    ]
}

createUtmServer

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
serverName
string
serverType
string
Array of objects (UtmModule) unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "serverName": "string",
  • "serverType": "string",
  • "modules": [
    ]
}

getUtmServer

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmServer

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmServers

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmServerCriteria)

Responses

utm-server-module-resource

getAllUtmServerModules

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmServerModuleCriteria)
required
object (Pageable)

Responses

updateUtmServerModule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
serverId
integer <int64>
moduleName
string
needsRestart
boolean
prettyName
string
object (UtmServer)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "serverId": 0,
  • "moduleName": "string",
  • "needsRestart": true,
  • "prettyName": "string",
  • "server": {
    }
}

createUtmServerModule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
serverId
integer <int64>
moduleName
string
needsRestart
boolean
prettyName
string
object (UtmServer)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "serverId": 0,
  • "moduleName": "string",
  • "needsRestart": true,
  • "prettyName": "string",
  • "server": {
    }
}

getUtmServerModule

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmServerModule

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

getModulesWithIntegrations

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
serverId
integer <int64>
prettyName
string

Responses

countUtmServerModules

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmServerModuleCriteria)

Responses

utm-schedule-resource

getAllUtmSchedules

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (Pageable)

Responses

updateUtmSchedule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
comment
string [ 0 .. 255 ] characters
firstTime
integer <int64>
period
integer <int64>
periodMonth
integer <int64>
duration
integer <int64>
timezone
string
initialOffset
integer <int64>
creationTime
integer <int64>
modificationTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "comment": "string",
  • "firstTime": 0,
  • "period": 0,
  • "periodMonth": 0,
  • "duration": 0,
  • "timezone": "string",
  • "initialOffset": 0,
  • "creationTime": 0,
  • "modificationTime": 0
}

createUtmSchedule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
comment
string [ 0 .. 255 ] characters
firstTime
integer <int64>
period
integer <int64>
periodMonth
integer <int64>
duration
integer <int64>
timezone
string
initialOffset
integer <int64>
creationTime
integer <int64>
modificationTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "comment": "string",
  • "firstTime": 0,
  • "period": 0,
  • "periodMonth": 0,
  • "duration": 0,
  • "timezone": "string",
  • "initialOffset": 0,
  • "creationTime": 0,
  • "modificationTime": 0
}

getUtmSchedule

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmSchedule

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

utm-report-resource

getAllUtmReports

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmReportCriteria)
required
object (Pageable)

Responses

updateUtmReports

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
repName
string [ 0 .. 255 ] characters
repDescription
string [ 0 .. 255 ] characters
reportSectionId
integer <int64>
dashboardId
integer <int64>
creationUser
string
creationDate
string <date-time>
modificationUser
string
modificationDate
string <date-time>
repUrl
string
repType
string
Enum: "CUSTOM_PDF" "CUSTOM_LIST" "TEMPLATE"
repModule
string
repShortName
string
repHttpMethod
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "repName": "string",
  • "repDescription": "string",
  • "reportSectionId": 0,
  • "dashboardId": 0,
  • "creationUser": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationUser": "string",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "repUrl": "string",
  • "repType": "CUSTOM_PDF",
  • "repModule": "string",
  • "repShortName": "string",
  • "repHttpMethod": "string"
}

createUtmReports

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
repName
string [ 0 .. 255 ] characters
repDescription
string [ 0 .. 255 ] characters
reportSectionId
integer <int64>
dashboardId
integer <int64>
creationUser
string
creationDate
string <date-time>
modificationUser
string
modificationDate
string <date-time>
repUrl
string
repType
string
Enum: "CUSTOM_PDF" "CUSTOM_LIST" "TEMPLATE"
repModule
string
repShortName
string
repHttpMethod
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "repName": "string",
  • "repDescription": "string",
  • "reportSectionId": 0,
  • "dashboardId": 0,
  • "creationUser": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationUser": "string",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "repUrl": "string",
  • "repType": "CUSTOM_PDF",
  • "repModule": "string",
  • "repShortName": "string",
  • "repHttpMethod": "string"
}

getUtmReports

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmReports

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmReports

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmReportCriteria)

Responses

utm-report-section-resource

getAllUtmReportSections

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmReportSectionCriteria)
required
object (Pageable)

Responses

updateUtmReportSection

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
repSecName
string
repSecDescription
required
string
repSecSystem
boolean
creationUser
string
creationDate
string <date-time>
modificationUser
string
modificationDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "repSecName": "string",
  • "repSecDescription": "string",
  • "repSecSystem": true,
  • "creationUser": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationUser": "string",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

createUtmReportSection

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
repSecName
string
repSecDescription
required
string
repSecSystem
boolean
creationUser
string
creationDate
string <date-time>
modificationUser
string
modificationDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "repSecName": "string",
  • "repSecDescription": "string",
  • "repSecSystem": true,
  • "creationUser": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationUser": "string",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

getUtmReportSection

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmReportSection

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmReportSections

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmReportSectionCriteria)

Responses

utm-ports-resource

getAllUtmOpenPorts

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmPortsCriteria)
required
object (Pageable)

Responses

updateUtmOpenPort

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
scanId
integer <int64>
port
integer <int32>
tcp
string
udp
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "scanId": 0,
  • "port": 0,
  • "tcp": "string",
  • "udp": "string"
}

createUtmOpenPort

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
scanId
integer <int64>
port
integer <int32>
tcp
string
udp
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "scanId": 0,
  • "port": 0,
  • "tcp": "string",
  • "udp": "string"
}

getUtmOpenPort

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmOpenPort

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmOpenPorts

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmPortsCriteria)

Responses

utm-network-scan-resource

getAllUtmNetworkScans

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmNetworkScanCriteria)
required
object (Pageable)

Responses

updateUtmNetworkScan

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
assetIp
string [ 0 .. 255 ] characters
assetAddresses
string
assetMac
string [ 0 .. 255 ] characters
assetOs
string [ 0 .. 255 ] characters
assetOsArch
string [ 0 .. 100 ] characters
assetOsMajorVersion
string [ 0 .. 20 ] characters
assetOsMinorVersion
string [ 0 .. 20 ] characters
assetOsPlatform
string [ 0 .. 100 ] characters
assetOsVersion
string [ 0 .. 100 ] characters
assetName
string [ 0 .. 255 ] characters
assetAliases
string [ 0 .. 500 ] characters
assetAlias
string
assetAlive
boolean
assetStatus
string
Enum: "NEW" "CHECK" "MISSING"
assetSeverityMetric
number <float>
discoveredAt
string <date-time>
modifiedAt
string <date-time>
assetNotes
string
serverName
string [ 0 .. 255 ] characters
groupId
integer <int64>
registeredMode
string
Enum: "CUSTOM" "DISCOVERED" "DYNAMIC"
isAgent
boolean
registerIp
string [ 0 .. 50 ] characters
updateLevel
string
Enum: "DATASOURCE" "SCANNER" "AGENT"
object (UtmAssetTypes)
Array of objects (UtmPorts)
Array of objects (UtmAssetMetrics)
Array of objects (UtmDataInputStatus)
object (UtmAssetGroup)
uuid
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "assetIp": "string",
  • "assetAddresses": "string",
  • "assetMac": "string",
  • "assetOs": "string",
  • "assetOsArch": "string",
  • "assetOsMajorVersion": "string",
  • "assetOsMinorVersion": "string",
  • "assetOsPlatform": "string",
  • "assetOsVersion": "string",
  • "assetName": "string",
  • "assetAliases": "string",
  • "assetAlias": "string",
  • "assetAlive": true,
  • "assetStatus": "NEW",
  • "assetSeverityMetric": 0.1,
  • "discoveredAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "assetNotes": "string",
  • "serverName": "string",
  • "groupId": 0,
  • "registeredMode": "CUSTOM",
  • "isAgent": true,
  • "registerIp": "string",
  • "updateLevel": "DATASOURCE",
  • "assetType": {
    },
  • "ports": [
    ],
  • "metrics": [
    ],
  • "dataInputList": [
    ],
  • "assetGroup": {
    },
  • "uuid": 0
}

updateType

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
assetsIds
required
Array of integers <int64> [ items <int64 > ]
assetTypeId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "assetsIds": [
    ],
  • "assetTypeId": 0
}

updateGroup

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
assetsIds
required
Array of integers <int64> [ items <int64 > ]
assetGroupId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "assetsIds": [
    ],
  • "assetGroupId": 0
}

saveOrUpdateCustomAsset

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
assetIp
string
assetAddresses
string
assetMac
string
assetOs
string
assetOsArch
string
assetOsMajorVersion
string
assetOsMinorVersion
string
assetOsPlatform
string
assetOsVersion
string
assetName
string
assetAliases
string
assetAlias
string
serverName
string
assetAlive
boolean
registeredMode
string
Enum: "CUSTOM" "DISCOVERED" "DYNAMIC"
assetStatus
string
Enum: "NEW" "CHECK" "MISSING"
assetSeverityMetric
number <float>
object (UtmAssetTypes)
assetNotes
string
discoveredAt
string <date-time>
modifiedAt
string <date-time>
object
Array of objects (Port) unique
object (UtmAssetGroup)
Array of objects (UtmDataInputStatus)
agent
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "assetIp": "string",
  • "assetAddresses": "string",
  • "assetMac": "string",
  • "assetOs": "string",
  • "assetOsArch": "string",
  • "assetOsMajorVersion": "string",
  • "assetOsMinorVersion": "string",
  • "assetOsPlatform": "string",
  • "assetOsVersion": "string",
  • "assetName": "string",
  • "assetAliases": "string",
  • "assetAlias": "string",
  • "serverName": "string",
  • "assetAlive": true,
  • "registeredMode": "CUSTOM",
  • "assetStatus": "NEW",
  • "assetSeverityMetric": 0.1,
  • "assetType": {
    },
  • "assetNotes": "string",
  • "discoveredAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "metrics": {
    },
  • "ports": [
    ],
  • "group": {
    },
  • "dataInputList": [
    ],
  • "agent": true
}

getUtmNetworkScan

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

searchPropertyValues

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
prop
required
string
Enum: "IP" "MAC" "ALIAS" "NAME" "OS" "ALIVE" "STATUS" "PROBE" "TYPE" "SEVERITY" "PORTS" "GROUP"
value
string
forGroups
required
boolean
required
object (Pageable)

Responses

searchByFilters

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
assetIpMacName
string
os
Array of strings
alive
Array of booleans
status
Array of strings
Items Enum: "NEW" "CHECK" "MISSING"
type
Array of strings
alias
Array of strings
probe
Array of strings
openPorts
Array of integers <int32> [ items <int32 > ]
groups
Array of strings
discoveredInitDate
string <date-time>
discoveredEndDate
string <date-time>
registeredMode
string
Enum: "CUSTOM" "DISCOVERED" "DYNAMIC"
agent
Array of booleans
osPlatform
Array of strings
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

getNetworkScanReport

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (NetworkScanFilter)
required
object (Pageable)

Responses

countUtmNetworkScans

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmNetworkScanCriteria)

Responses

countNewAssets

Authorizations:
(bearerAuthApiKeyAuth)

Responses

canRunCommand

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
assetName
required
string

Responses

getAgentsOsPlatform

Authorizations:
(bearerAuthApiKeyAuth)

Responses

deleteCustomAsset

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

utm-module-resource

activateDeactivate

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
serverId
required
integer <int64>
nameShort
required
string
Enum: "FILE_INTEGRITY" "NETFLOW" "WINDOWS_AGENT" "SYSLOG" "LINUX_LOGS" "VMWARE" "AWS_TRAFFIC_MIRROR" "AWS_IAM_USER" "AWS_CLOUDTRAIL" "AIX" "AWS_SQL_SERVER" "AWS_POSTGRESQL" "AWS_BEANSTALK" "AWS_FARGATE" "AWS_LAMBDA" "AD_AUDIT" "SOPHOS" "AZURE" "O365" "IIS" "GCP" "JSON" "MACOS_AGENT" "LINUX_AGENT" "APACHE" "APACHE2" "AUDITD" "ELASTICSEARCH" "HAPROXY" "KAFKA" "KIBANA" "LOGSTASH" "MONGODB" "MYSQL" "NATS" "NGINX" "OSQUERY" "POSTGRESQL" "REDIS" "TRAEFIK" "CISCO" "MERAKI" "ESET" "KASPERSKY" "SENTINEL_ONE" "FORTIGATE" "FORTIWEB" "SOPHOS_XG" "FIRE_POWER" "UFW" "MACOS" "MIKROTIK" "PALO_ALTO" "CISCO_SWITCH" "SONIC_WALL" "DECEPTIVE_BYTES" "GITHUB" "IBM_AS_400" "SALESFORCE" "BITDEFENDER" "SOC_AI" "PFSENSE"
activationStatus
required
boolean

Responses

getAllUtmModules

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmModuleCriteria)
required
object (Pageable)

Responses

getModuleDetails

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
serverId
required
integer <int64>
nameShort
required
string
Enum: "FILE_INTEGRITY" "NETFLOW" "WINDOWS_AGENT" "SYSLOG" "LINUX_LOGS" "VMWARE" "AWS_TRAFFIC_MIRROR" "AWS_IAM_USER" "AWS_CLOUDTRAIL" "AIX" "AWS_SQL_SERVER" "AWS_POSTGRESQL" "AWS_BEANSTALK" "AWS_FARGATE" "AWS_LAMBDA" "AD_AUDIT" "SOPHOS" "AZURE" "O365" "IIS" "GCP" "JSON" "MACOS_AGENT" "LINUX_AGENT" "APACHE" "APACHE2" "AUDITD" "ELASTICSEARCH" "HAPROXY" "KAFKA" "KIBANA" "LOGSTASH" "MONGODB" "MYSQL" "NATS" "NGINX" "OSQUERY" "POSTGRESQL" "REDIS" "TRAEFIK" "CISCO" "MERAKI" "ESET" "KASPERSKY" "SENTINEL_ONE" "FORTIGATE" "FORTIWEB" "SOPHOS_XG" "FIRE_POWER" "UFW" "MACOS" "MIKROTIK" "PALO_ALTO" "CISCO_SWITCH" "SONIC_WALL" "DECEPTIVE_BYTES" "GITHUB" "IBM_AS_400" "SALESFORCE" "BITDEFENDER" "SOC_AI" "PFSENSE"

Responses

getModuleCategories

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
serverId
integer <int64>

Responses

getModuleDetailsDecrypted

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
nameShort
required
string
Enum: "FILE_INTEGRITY" "NETFLOW" "WINDOWS_AGENT" "SYSLOG" "LINUX_LOGS" "VMWARE" "AWS_TRAFFIC_MIRROR" "AWS_IAM_USER" "AWS_CLOUDTRAIL" "AIX" "AWS_SQL_SERVER" "AWS_POSTGRESQL" "AWS_BEANSTALK" "AWS_FARGATE" "AWS_LAMBDA" "AD_AUDIT" "SOPHOS" "AZURE" "O365" "IIS" "GCP" "JSON" "MACOS_AGENT" "LINUX_AGENT" "APACHE" "APACHE2" "AUDITD" "ELASTICSEARCH" "HAPROXY" "KAFKA" "KIBANA" "LOGSTASH" "MONGODB" "MYSQL" "NATS" "NGINX" "OSQUERY" "POSTGRESQL" "REDIS" "TRAEFIK" "CISCO" "MERAKI" "ESET" "KASPERSKY" "SENTINEL_ONE" "FORTIGATE" "FORTIWEB" "SOPHOS_XG" "FIRE_POWER" "UFW" "MACOS" "MIKROTIK" "PALO_ALTO" "CISCO_SWITCH" "SONIC_WALL" "DECEPTIVE_BYTES" "GITHUB" "IBM_AS_400" "SALESFORCE" "BITDEFENDER" "SOC_AI" "PFSENSE"

Responses

isActive

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
moduleName
required
string
Enum: "FILE_INTEGRITY" "NETFLOW" "WINDOWS_AGENT" "SYSLOG" "LINUX_LOGS" "VMWARE" "AWS_TRAFFIC_MIRROR" "AWS_IAM_USER" "AWS_CLOUDTRAIL" "AIX" "AWS_SQL_SERVER" "AWS_POSTGRESQL" "AWS_BEANSTALK" "AWS_FARGATE" "AWS_LAMBDA" "AD_AUDIT" "SOPHOS" "AZURE" "O365" "IIS" "GCP" "JSON" "MACOS_AGENT" "LINUX_AGENT" "APACHE" "APACHE2" "AUDITD" "ELASTICSEARCH" "HAPROXY" "KAFKA" "KIBANA" "LOGSTASH" "MONGODB" "MYSQL" "NATS" "NGINX" "OSQUERY" "POSTGRESQL" "REDIS" "TRAEFIK" "CISCO" "MERAKI" "ESET" "KASPERSKY" "SENTINEL_ONE" "FORTIGATE" "FORTIWEB" "SOPHOS_XG" "FIRE_POWER" "UFW" "MACOS" "MIKROTIK" "PALO_ALTO" "CISCO_SWITCH" "SONIC_WALL" "DECEPTIVE_BYTES" "GITHUB" "IBM_AS_400" "SALESFORCE" "BITDEFENDER" "SOC_AI" "PFSENSE"

Responses

checkRequirements

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
serverId
required
integer <int64>
nameShort
required
string
Enum: "FILE_INTEGRITY" "NETFLOW" "WINDOWS_AGENT" "SYSLOG" "LINUX_LOGS" "VMWARE" "AWS_TRAFFIC_MIRROR" "AWS_IAM_USER" "AWS_CLOUDTRAIL" "AIX" "AWS_SQL_SERVER" "AWS_POSTGRESQL" "AWS_BEANSTALK" "AWS_FARGATE" "AWS_LAMBDA" "AD_AUDIT" "SOPHOS" "AZURE" "O365" "IIS" "GCP" "JSON" "MACOS_AGENT" "LINUX_AGENT" "APACHE" "APACHE2" "AUDITD" "ELASTICSEARCH" "HAPROXY" "KAFKA" "KIBANA" "LOGSTASH" "MONGODB" "MYSQL" "NATS" "NGINX" "OSQUERY" "POSTGRESQL" "REDIS" "TRAEFIK" "CISCO" "MERAKI" "ESET" "KASPERSKY" "SENTINEL_ONE" "FORTIGATE" "FORTIWEB" "SOPHOS_XG" "FIRE_POWER" "UFW" "MACOS" "MIKROTIK" "PALO_ALTO" "CISCO_SWITCH" "SONIC_WALL" "DECEPTIVE_BYTES" "GITHUB" "IBM_AS_400" "SALESFORCE" "BITDEFENDER" "SOC_AI" "PFSENSE"

Responses

utm-menu-authority-resource

getAllUtmMenuAuthorities

Authorizations:
(bearerAuthApiKeyAuth)

Responses

updateUtmMenuAuthority

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
menuId
required
integer <int64>
authorityName
required
string
object (UtmMenu)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "menuId": 0,
  • "authorityName": "string",
  • "menu": {
    }
}

createUtmMenuAuthority

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
menuId
required
integer <int64>
authorityName
required
string
object (UtmMenu)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "menuId": 0,
  • "authorityName": "string",
  • "menu": {
    }
}

getUtmMenuAuthority

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmMenuAuthority

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

utm-logstash-filter-group-resource

getAllUtmLogstashFilterGroups

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmLogstashFilterGroupCriteria)
required
object (Pageable)

Responses

updateUtmLogstashFilterGroup

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
groupName
required
string [ 0 .. 150 ] characters
groupDescription
string
systemOwner
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "groupName": "string",
  • "groupDescription": "string",
  • "systemOwner": true
}

createUtmLogstashFilterGroup

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
groupName
required
string [ 0 .. 150 ] characters
groupDescription
string
systemOwner
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "groupName": "string",
  • "groupDescription": "string",
  • "systemOwner": true
}

getUtmLogstashFilterGroup

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmLogstashFilterGroup

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmLogstashFilterGroups

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmLogstashFilterGroupCriteria)

Responses

utm-integration-resource

getAllUtmIntegrations

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIntegrationCriteria)
required
object (Pageable)

Responses

updateUtmIntegration

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
moduleId
integer <int64>
integrationName
string
integrationDescription
string
url
string
integrationIconPath
string
object (UtmServerModule)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "moduleId": 0,
  • "integrationName": "string",
  • "integrationDescription": "string",
  • "url": "string",
  • "integrationIconPath": "string",
  • "module": {
    }
}

createUtmIntegration

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
moduleId
integer <int64>
integrationName
string
integrationDescription
string
url
string
integrationIconPath
string
object (UtmServerModule)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "moduleId": 0,
  • "integrationName": "string",
  • "integrationDescription": "string",
  • "url": "string",
  • "integrationIconPath": "string",
  • "module": {
    }
}

getUtmIntegration

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmIntegration

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmIntegrations

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIntegrationCriteria)

Responses

utm-integration-conf-resource

getAllUtmIntegrationConfs

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIntegrationConfCriteria)
required
object (Pageable)

Responses

updateUtmIntegrationConf

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
integrationId
integer <int64>
confShort
string
confLarge
string
confDescription
string
confValue
string
confDatatype
string
object (UtmIntegration)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "integrationId": 0,
  • "confShort": "string",
  • "confLarge": "string",
  • "confDescription": "string",
  • "confValue": "string",
  • "confDatatype": "string",
  • "integration": {
    }
}

createUtmIntegrationConf

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
integrationId
integer <int64>
confShort
string
confLarge
string
confDescription
string
confValue
string
confDatatype
string
object (UtmIntegration)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "integrationId": 0,
  • "confShort": "string",
  • "confLarge": "string",
  • "confDescription": "string",
  • "confValue": "string",
  • "confDatatype": "string",
  • "integration": {
    }
}

getUtmIntegrationConf

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmIntegrationConf

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmIntegrationConfs

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIntegrationConfCriteria)

Responses

utm-index-pattern-resource

getAllUtmIndexPatterns

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIndexPatternCriteria)
required
object (Pageable)

Responses

updateUtmIndexPattern

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
pattern
required
string [ 0 .. 100 ] characters
patternModule
string
patternSystem
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "pattern": "string",
  • "patternModule": "string",
  • "patternSystem": true,
  • "active": true
}

createUtmIndexPattern

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
pattern
required
string [ 0 .. 100 ] characters
patternModule
string
patternSystem
boolean
active
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "pattern": "string",
  • "patternModule": "string",
  • "patternSystem": true,
  • "active": true
}

getUtmIndexPattern

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmIndexPattern

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

utm-incident-resource

updateUtmIncident

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
incidentName
required
string [ 0 .. 250 ] characters
incidentDescription
required
string [ 0 .. 2000 ] characters
incidentStatus
required
string
Enum: "OPEN" "IN_REVIEW" "COMPLETED" "MERGED"
incidentAssignedTo
string
incidentSeverity
required
integer <int32>
incidentCreatedDate
required
string <date-time>
incidentSolution
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "incidentName": "string",
  • "incidentDescription": "string",
  • "incidentStatus": "OPEN",
  • "incidentAssignedTo": "string",
  • "incidentSeverity": 0,
  • "incidentCreatedDate": "2019-08-24T14:15:22Z",
  • "incidentSolution": "string"
}

getAllUtmIncidents

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIncidentCriteria)
required
object (Pageable)

Responses

createUtmIncident

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
incidentName
required
string^[^"]*$
incidentDescription
string
incidentAssignedTo
string
required
Array of objects (RelatedIncidentAlertsDTO)

Responses

Request samples

Content type
application/json
{
  • "incidentName": "string",
  • "incidentDescription": "string",
  • "incidentAssignedTo": "string",
  • "alertList": [
    ]
}

addAlertsToUtmIncident

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
incidentId
required
integer <int64>
required
Array of objects (RelatedIncidentAlertsDTO)

Responses

Request samples

Content type
application/json
{
  • "incidentId": 0,
  • "alertList": [
    ]
}

getUtmIncident

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

getAllUserAssigned

Authorizations:
(bearerAuthApiKeyAuth)

Responses

utm-incident-variable-resource

getAllUtmIncidentVariables

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIncidentVariableCriteria)
required
object (Pageable)

Responses

updateUtmIncidentVariable

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
variableName
string
variableValue
string
variableDescription
string
createdBy
string
lastModifiedDate
string <date-time>
lastModifiedBy
string
secret
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "variableName": "string",
  • "variableValue": "string",
  • "variableDescription": "string",
  • "createdBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "secret": true
}

createUtmIncidentVariable

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
variableName
string
variableValue
string
variableDescription
string
createdBy
string
lastModifiedDate
string <date-time>
lastModifiedBy
string
secret
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "variableName": "string",
  • "variableValue": "string",
  • "variableDescription": "string",
  • "createdBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "secret": true
}

deleteUtmIncidentVariable

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

utm-incident-alert-resource

getAllUtmIncidentAlerts

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIncidentAlertCriteria)
required
object (Pageable)

Responses

updateUtmIncidentAlert

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
incidentId
required
integer <int64>
alertId
required
string
alertName
required
string
alertStatus
required
integer <int32>
alertSeverity
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "incidentId": 0,
  • "alertId": "string",
  • "alertName": "string",
  • "alertStatus": 0,
  • "alertSeverity": 0
}

createUtmIncidentAlert

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
incidentId
required
integer <int64>
alertId
required
string
alertName
required
string
alertStatus
required
integer <int32>
alertSeverity
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "incidentId": 0,
  • "alertId": "string",
  • "alertName": "string",
  • "alertStatus": 0,
  • "alertSeverity": 0
}

updateIncidentAlertStatus

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
incidentId
required
integer <int64>
alertIds
required
Array of strings
status
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "incidentId": 0,
  • "alertIds": [
    ],
  • "status": 0
}

deleteUtmIncidentAlert

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

utm-incident-action-resource

getAllUtmIncidentActions

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIncidentActionCriteria)
required
object (Pageable)

Responses

updateUtmIncidentAction

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
actionCommand
string
actionDescription
string
actionParams
string
actionType
integer <int32>
actionEditable
boolean
createdDate
string <date-time>
modifiedDate
string <date-time>
createdUser
string
modifiedUser
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "actionCommand": "string",
  • "actionDescription": "string",
  • "actionParams": "string",
  • "actionType": 0,
  • "actionEditable": true,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdUser": "string",
  • "modifiedUser": "string"
}

createUtmIncidentAction

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
actionCommand
string
actionDescription
string
actionParams
string
actionType
integer <int32>
actionEditable
boolean
createdDate
string <date-time>
modifiedDate
string <date-time>
createdUser
string
modifiedUser
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "actionCommand": "string",
  • "actionDescription": "string",
  • "actionParams": "string",
  • "actionType": 0,
  • "actionEditable": true,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdUser": "string",
  • "modifiedUser": "string"
}

getUtmIncidentAction

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

deleteUtmIncidentAction

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
integer <int64>

Responses

countUtmIncidentActions

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (UtmIncidentActionCriteria)

Responses

utm-data-source-config-resource

getAllDataSourceConfigs

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

update

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array
id
string
dataType
string
dataTypeName
string
systemOwner
boolean
included
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

utm-data-input-status-resource

getAllUtmDataInputStatuses

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (Pageable)

Responses

updateUtmDataInputStatus

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
string
source
required
string [ 0 .. 256 ] characters
dataType
required
string [ 0 .. 50 ] characters
timestamp
required
integer <int64>
median
integer <int64>
down
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "source": "string",
  • "dataType": "string",
  • "timestamp": 0,
  • "median": 0,
  • "down": true
}

createUtmDataInputStatus

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
string
source
required
string [ 0 .. 256 ] characters
dataType
required
string [ 0 .. 50 ] characters
timestamp
required
integer <int64>
median
integer <int64>
down
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "source": "string",
  • "dataType": "string",
  • "timestamp": 0,
  • "median": 0,
  • "down": true
}

getUtmDataInputStatus

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
string

Responses

deleteUtmDataInputStatus

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
string

Responses