API docs by Redocly

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

countUtmDataInputStatuses

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

Responses

utm-dashboard-resource

getAllUtmDashboards

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

Responses

updateUtmDashboard

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
description
required
string [ 0 .. 255 ] characters
refreshTime
integer <int64>
createdDate
required
string <date-time>
modifiedDate
string <date-time>
userCreated
required
string [ 0 .. 50 ] characters
userModified
string [ 0 .. 50 ] characters
filters
string
dashboardType
string
Enum: "CUSTOM" "COMPLIANCE" "REPORT"
systemOwner
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "refreshTime": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "userCreated": "string",
  • "userModified": "string",
  • "filters": "string",
  • "dashboardType": "CUSTOM",
  • "systemOwner": true
}

createUtmDashboard

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
description
required
string [ 0 .. 255 ] characters
refreshTime
integer <int64>
createdDate
required
string <date-time>
modifiedDate
string <date-time>
userCreated
required
string [ 0 .. 50 ] characters
userModified
string [ 0 .. 50 ] characters
filters
string
dashboardType
string
Enum: "CUSTOM" "COMPLIANCE" "REPORT"
systemOwner
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "refreshTime": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "userCreated": "string",
  • "userModified": "string",
  • "filters": "string",
  • "dashboardType": "CUSTOM",
  • "systemOwner": true
}

importDashboards

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

Responses

Request samples

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

getUtmDashboard

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

Responses

deleteUtmDashboard

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

Responses

utm-dashboard-visualization-resource

getAllUtmDashboardVisualizations

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

Responses

updateUtmDashboardVisualization

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
idVisualization
required
integer <int64>
idDashboard
required
integer <int64>
order
required
integer <int32>
width
required
number <float>
height
required
number <float>
top
required
number <float>
left
required
number <float>
showTimeFilter
boolean
defaultTimeRange
string
gridInfo
string
object (UtmVisualization)
object (UtmDashboard)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "idVisualization": 0,
  • "idDashboard": 0,
  • "order": 0,
  • "width": 0.1,
  • "height": 0.1,
  • "top": 0.1,
  • "left": 0.1,
  • "showTimeFilter": true,
  • "defaultTimeRange": "string",
  • "gridInfo": "string",
  • "visualization": {
    },
  • "dashboard": {
    }
}

createUtmDashboardVisualization

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
idVisualization
required
integer <int64>
idDashboard
required
integer <int64>
order
required
integer <int32>
width
required
number <float>
height
required
number <float>
top
required
number <float>
left
required
number <float>
showTimeFilter
boolean
defaultTimeRange
string
gridInfo
string
object (UtmVisualization)
object (UtmDashboard)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "idVisualization": 0,
  • "idDashboard": 0,
  • "order": 0,
  • "width": 0.1,
  • "height": 0.1,
  • "top": 0.1,
  • "left": 0.1,
  • "showTimeFilter": true,
  • "defaultTimeRange": "string",
  • "gridInfo": "string",
  • "visualization": {
    },
  • "dashboard": {
    }
}

getUtmDashboardVisualization

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

Responses

deleteUtmDashboardVisualization

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

Responses

utm-dashboard-authority-resource

getAllUtmDashboardAuthorities

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

Responses

updateUtmDashboardAuthority

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
idDashboard
required
integer <int64>
authorityName
required
string [ 0 .. 50 ] characters

Responses

Request samples

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

createUtmDashboardAuthority

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
idDashboard
required
integer <int64>
authorityName
required
string [ 0 .. 50 ] characters

Responses

Request samples

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

getUtmDashboardAuthority

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

Responses

deleteUtmDashboardAuthority

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

Responses

utm-configuration-parameter-resource

getAllUtmConfigurationParameters

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
id.greaterThan
integer <int64>
id.lessThan
integer <int64>
id.greaterThanOrEqual
integer <int64>
id.lessThanOrEqual
integer <int64>
id.equals
integer <int64>
id.notEquals
integer <int64>
id.specified
boolean
id.in
Array of integers <int64> [ items <int64 > ]
id.notIn
Array of integers <int64> [ items <int64 > ]
sectionId.greaterThan
integer <int64>
sectionId.lessThan
integer <int64>
sectionId.greaterThanOrEqual
integer <int64>
sectionId.lessThanOrEqual
integer <int64>
sectionId.equals
integer <int64>
sectionId.notEquals
integer <int64>
sectionId.specified
boolean
sectionId.in
Array of integers <int64> [ items <int64 > ]
sectionId.notIn
Array of integers <int64> [ items <int64 > ]
confParamShort.contains
string
confParamShort.doesNotContain
string
confParamShort.equals
string
confParamShort.notEquals
string
confParamShort.specified
boolean
confParamShort.in
Array of strings
confParamShort.notIn
Array of strings
confParamLarge.contains
string
confParamLarge.doesNotContain
string
confParamLarge.equals
string
confParamLarge.notEquals
string
confParamLarge.specified
boolean
confParamLarge.in
Array of strings
confParamLarge.notIn
Array of strings
confParamDescription.contains
string
confParamDescription.doesNotContain
string
confParamDescription.equals
string
confParamDescription.notEquals
string
confParamDescription.specified
boolean
confParamDescription.in
Array of strings
confParamDescription.notIn
Array of strings
confParamValue.contains
string
confParamValue.doesNotContain
string
confParamValue.equals
string
confParamValue.notEquals
string
confParamValue.specified
boolean
confParamValue.in
Array of strings
confParamValue.notIn
Array of strings
confParamDatatype.contains
string
confParamDatatype.doesNotContain
string
confParamDatatype.equals
string
confParamDatatype.notEquals
string
confParamDatatype.specified
boolean
confParamDatatype.in
Array of strings
confParamDatatype.notIn
Array of strings
confParamRequired.equals
boolean
confParamRequired.notEquals
boolean
confParamRequired.specified
boolean
confParamRequired.in
Array of booleans
confParamRequired.notIn
Array of booleans
modificationTime.greaterThan
string <date-time>
modificationTime.lessThan
string <date-time>
modificationTime.greaterThanOrEqual
string <date-time>
modificationTime.lessThanOrEqual
string <date-time>
modificationTime.equals
string <date-time>
modificationTime.notEquals
string <date-time>
modificationTime.specified
boolean
modificationTime.in
Array of strings <date-time> [ items <date-time > ]
modificationTime.notIn
Array of strings <date-time> [ items <date-time > ]
modificationUser.contains
string
modificationUser.doesNotContain
string
modificationUser.equals
string
modificationUser.notEquals
string
modificationUser.specified
boolean
modificationUser.in
Array of strings
modificationUser.notIn
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

updateConfigurationParameters

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array
id
integer <int64>
sectionId
required
integer <int64>
confParamShort
required
string [ 0 .. 100 ] characters
confParamLarge
string
confParamDescription
string
confParamValue
string
confParamRegexp
string
confParamRequired
boolean
confParamDatatype
string
modificationTime
string <date-time>
modificationUser
string
confParamOption
string
object (UtmConfigurationSection)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

checkEmailConfiguration

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array
id
integer <int64>
sectionId
required
integer <int64>
confParamShort
required
string [ 0 .. 100 ] characters
confParamLarge
string
confParamDescription
string
confParamValue
string
confParamRegexp
string
confParamRequired
boolean
confParamDatatype
string
modificationTime
string <date-time>
modificationUser
string
confParamOption
string
object (UtmConfigurationSection)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

getUtmConfigurationParameter

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

Responses

utm-module-group-resource

updateUtmConfigurationGroup

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
moduleId
required
integer <int64>
groupName
required
string
groupDescription
string
Array of objects (UtmModuleGroupConfiguration) unique

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "moduleId": 0,
  • "groupName": "string",
  • "groupDescription": "string",
  • "moduleGroupConfigurations": [
    ]
}

createConfigurationGroup

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
name
required
string
description
string
moduleId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "moduleId": 0
}

getConfigurationGroup

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

Responses

getModuleGroups

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
moduleId
required
integer <int64>

Responses

deleteSingleModuleGroup

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
groupId
required
integer <int64>

Responses

deleteAllModuleGroups

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
moduleId
required
integer <int64>

Responses

utm-asset-metrics-resource

getAllUtmAssetMetrics

Authorizations:
(bearerAuthApiKeyAuth)

Responses

updateUtmAssetMetrics

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
string
assetName
required
string
metric
required
string
amount
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "assetName": "string",
  • "metric": "string",
  • "amount": 0
}

createUtmAssetMetrics

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
string
assetName
required
string
metric
required
string
amount
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "assetName": "string",
  • "metric": "string",
  • "amount": 0
}

getUtmAssetMetrics

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
string

Responses

deleteUtmAssetMetrics

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
string

Responses

utm-asset-group-resource

updateUtmAssetGroup

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
groupName
required
string [ 0 .. 100 ] characters
groupDescription
string
createdDate
string <date-time>
Array of objects (UtmAssetMetrics)
Array of objects (UtmNetworkScan)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "groupName": "string",
  • "groupDescription": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "metrics": [
    ],
  • "assets": [
    ]
}

createUtmAssetGroup

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
groupName
required
string [ 0 .. 100 ] characters
groupDescription
string
createdDate
string <date-time>
Array of objects (UtmAssetMetrics)
Array of objects (UtmNetworkScan)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "groupName": "string",
  • "groupDescription": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "metrics": [
    ],
  • "assets": [
    ]
}

getUtmAssetGroup

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

Responses

deleteUtmAssetGroup

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

Responses

searchGroupsByFilter

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

Responses

utm-alert-tag-resource

getAllUtmAlertCategories

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

Responses

updateUtmAlertTag

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
tagName
required
string [ 0 .. 50 ] characters
tagColor
string [ 0 .. 15 ] characters
systemOwner
boolean

Responses

Request samples

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

createUtmAlertTag

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
tagName
required
string [ 0 .. 50 ] characters
tagColor
string [ 0 .. 15 ] characters
systemOwner
boolean

Responses

Request samples

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

getUtmAlertTag

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

Responses

deleteUtmAlertTag

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

Responses

utm-alert-response-rule-resource

getAllAlertResponseRules

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
id.greaterThan
integer <int64>
id.lessThan
integer <int64>
id.greaterThanOrEqual
integer <int64>
id.lessThanOrEqual
integer <int64>
id.equals
integer <int64>
id.notEquals
integer <int64>
id.specified
boolean
id.in
Array of integers <int64> [ items <int64 > ]
id.notIn
Array of integers <int64> [ items <int64 > ]
name.contains
string
name.doesNotContain
string
name.equals
string
name.notEquals
string
name.specified
boolean
name.in
Array of strings
name.notIn
Array of strings
active.equals
boolean
active.notEquals
boolean
active.specified
boolean
active.in
Array of booleans
active.notIn
Array of booleans
agentPlatform.contains
string
agentPlatform.doesNotContain
string
agentPlatform.equals
string
agentPlatform.notEquals
string
agentPlatform.specified
boolean
agentPlatform.in
Array of strings
agentPlatform.notIn
Array of strings
createdBy.contains
string
createdBy.doesNotContain
string
createdBy.equals
string
createdBy.notEquals
string
createdBy.specified
boolean
createdBy.in
Array of strings
createdBy.notIn
Array of strings
lastModifiedBy.contains
string
lastModifiedBy.doesNotContain
string
lastModifiedBy.equals
string
lastModifiedBy.notEquals
string
lastModifiedBy.specified
boolean
lastModifiedBy.in
Array of strings
lastModifiedBy.notIn
Array of strings
createdDate.greaterThan
string <date-time>
createdDate.lessThan
string <date-time>
createdDate.greaterThanOrEqual
string <date-time>
createdDate.lessThanOrEqual
string <date-time>
createdDate.equals
string <date-time>
createdDate.notEquals
string <date-time>
createdDate.specified
boolean
createdDate.in
Array of strings <date-time> [ items <date-time > ]
createdDate.notIn
Array of strings <date-time> [ items <date-time > ]
lastModifiedDate.greaterThan
string <date-time>
lastModifiedDate.lessThan
string <date-time>
lastModifiedDate.greaterThanOrEqual
string <date-time>
lastModifiedDate.lessThanOrEqual
string <date-time>
lastModifiedDate.equals
string <date-time>
lastModifiedDate.notEquals
string <date-time>
lastModifiedDate.specified
boolean
lastModifiedDate.in
Array of strings <date-time> [ items <date-time > ]
lastModifiedDate.notIn
Array of strings <date-time> [ items <date-time > ]
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

updateAlertResponseRule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 150 ] characters
description
string [ 0 .. 512 ] characters
required
Array of objects (FilterType)
command
required
string
active
required
boolean
agentPlatform
required
string
defaultAgent
string [ 0 .. 500 ] characters
excludedAgents
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "conditions": [
    ],
  • "command": "string",
  • "active": true,
  • "agentPlatform": "string",
  • "defaultAgent": "string",
  • "excludedAgents": [
    ]
}

createAlertResponseRule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 150 ] characters
description
string [ 0 .. 512 ] characters
required
Array of objects (FilterType)
command
required
string
active
required
boolean
agentPlatform
required
string
defaultAgent
string [ 0 .. 500 ] characters
excludedAgents
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "conditions": [
    ],
  • "command": "string",
  • "active": true,
  • "agentPlatform": "string",
  • "defaultAgent": "string",
  • "excludedAgents": [
    ]
}

getAlertResponseRule

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

Responses

resolveFilterValues

Authorizations:
(bearerAuthApiKeyAuth)

Responses

utm-alert-log-resource

getAllUtmAlertLogs

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

Responses

updateUtmAlertLog

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
alertId
required
string [ 0 .. 100 ] characters
logUser
required
string [ 0 .. 50 ] characters
logDate
required
string <date-time>
logAction
required
string [ 0 .. 50 ] characters
logOldValue
string
logNewValue
string
logMessage
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "alertId": "string",
  • "logUser": "string",
  • "logDate": "2019-08-24T14:15:22Z",
  • "logAction": "string",
  • "logOldValue": "string",
  • "logNewValue": "string",
  • "logMessage": "string"
}

createUtmAlertLog

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
alertId
required
string [ 0 .. 100 ] characters
logUser
required
string [ 0 .. 50 ] characters
logDate
required
string <date-time>
logAction
required
string [ 0 .. 50 ] characters
logOldValue
string
logNewValue
string
logMessage
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "alertId": "string",
  • "logUser": "string",
  • "logDate": "2019-08-24T14:15:22Z",
  • "logAction": "string",
  • "logOldValue": "string",
  • "logNewValue": "string",
  • "logMessage": "string"
}

getUtmAlertLog

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

Responses

deleteUtmAlertLog

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

Responses

countUtmAlertLogs

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

Responses

user-resource

getAllUsers

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

Responses

updateUser

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
login
required
string [ 1 .. 50 ] characters ^[_.@A-Za-z0-9-]*$
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
string [ 5 .. 254 ] characters
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string [ 2 .. 6 ] characters
createdBy
string
createdDate
string <date-time>
lastModifiedBy
string
lastModifiedDate
string <date-time>
authorities
Array of strings unique
tfaSecret
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "imageUrl": "string",
  • "activated": true,
  • "langKey": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "tfaSecret": "string"
}

createUser

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
login
required
string [ 1 .. 50 ] characters ^[_.@A-Za-z0-9-]*$
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
string [ 5 .. 254 ] characters
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string [ 2 .. 6 ] characters
createdBy
string
createdDate
string <date-time>
lastModifiedBy
string
lastModifiedDate
string <date-time>
authorities
Array of strings unique
tfaSecret
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "imageUrl": "string",
  • "activated": true,
  • "langKey": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "tfaSecret": "string"
}

getUser

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
login
required
string

Responses

deleteUser

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
login
required
string

Responses

getUsersByLogin

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
login
required
string
query Parameters
required
object (Pageable)

Responses

getAuthorities

Authorizations:
(bearerAuthApiKeyAuth)

Responses

utm-module-group-configuration-resource

updateConfiguration

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

Responses

Request samples

Content type
application/json
{
  • "moduleId": 0,
  • "keys": [
    ]
}

getConfigurationByGroupId

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
groupId
required
integer <int64>

Responses

getConfigurationByGroupIdAndConfKey

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
groupId
required
integer <int64>
confKey
required
string

Responses

utm-menu-resource

getAllUtmMenu

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

Responses

updateUtmMenu

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 1 .. 50 ] characters
url
string
parentId
integer <int64>
type
integer <int32>
dashboardId
integer <int64>
position
integer <int64>
menuActive
boolean
menuAction
boolean
menuIcon
string
moduleNameShort
string
authorities
Array of strings
parent
object (UtmMenu) Recursive

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "url": "string",
  • "parentId": 0,
  • "type": 0,
  • "dashboardId": 0,
  • "position": 0,
  • "menuActive": true,
  • "menuAction": true,
  • "menuIcon": "string",
  • "moduleNameShort": "string",
  • "authorities": [
    ],
  • "parent": { }
}

createUtmMenu

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 1 .. 50 ] characters
url
string
parentId
integer <int64>
type
integer <int32>
dashboardId
integer <int64>
position
integer <int64>
menuActive
boolean
menuAction
boolean
menuIcon
string
moduleNameShort
string
authorities
Array of strings
parent
object (UtmMenu) Recursive

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "url": "string",
  • "parentId": 0,
  • "type": 0,
  • "dashboardId": 0,
  • "position": 0,
  • "menuActive": true,
  • "menuAction": true,
  • "menuIcon": "string",
  • "moduleNameShort": "string",
  • "authorities": [
    ],
  • "parent": { }
}

saveMenuStructure

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array
id
integer <int64>
name
string
url
string
parentId
integer <int64>
type
integer <int32>
dashboardId
integer <int64>
position
integer <int64>
menuActive
boolean
menuAction
boolean
menuIcon
string
modulesNameShort
string
authorities
Array of strings
childrens
Array of objects (MenuType)
actions
Array of objects (MenuType)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

getMenusByAuthorities

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
parentId
required
integer <int64>
authorities
required
Array of strings

Responses

getMenus

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
includeModulesMenus
required
boolean

Responses

deleteUtmMenu

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

Responses

utm-logstash-pipeline-resource

getAllActivePipelines

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_1

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array of objects (UtmGroupLogstashPipelineFilters)
Array of objects (InputConfiguration)
object (UtmLogstashPipelineDTO)

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "inputs": [
    ],
  • "pipeline": {
    }
}

createUtmLogstashPipeline

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array of objects (UtmGroupLogstashPipelineFilters)
Array of objects (InputConfiguration)
object (UtmLogstashPipelineDTO)

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "inputs": [
    ],
  • "pipeline": {
    }
}

validatePipelines

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
object (UtmLogstashPipelineVM)
mode
string

Responses

Request samples

Content type
application/json
{
  • "pipeline": {
    },
  • "mode": "string"
}

getUtmLogstashPipeline

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

Responses

deleteUtmLogstashPipeline

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

Responses

getLogstashStats

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getAllActivePipelinesPort

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.

isInternal
boolean

Responses

utm-logstash-input-resource

update_2

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
pipelineId
integer <int32>
inputPrettyName
string [ 0 .. 250 ] characters
inputPlugin
string [ 0 .. 100 ] characters
inputWithSsl
boolean
systemOwner
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "pipelineId": 0,
  • "inputPrettyName": "string",
  • "inputPlugin": "string",
  • "inputWithSsl": true,
  • "systemOwner": true
}

getAllowedInputTypes

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getInputDefinitionByType

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
type
required
string

Responses

getAvailableConfigValueByType

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
type
required
string

Responses

deleteUtmLogstashInput

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

Responses

utm-logstash-filter-resource

getAllLogstashFilters

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

Responses

updateLogstashFilter

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
filterName
string
logstashFilter
required
string
filterGroupId
integer <int64>
object (UtmLogstashFilterGroup)
systemOwner
boolean
moduleName
string
filterVersion
string
active
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "filterName": "string",
  • "logstashFilter": "string",
  • "filterGroupId": 0,
  • "group": {
    },
  • "systemOwner": true,
  • "moduleName": "string",
  • "filterVersion": "string",
  • "active": true
}

createLogstashFilter

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
pipelineId
required
integer <int64>
Request Body schema: application/json
required
id
integer <int64>
filterName
string
logstashFilter
required
string
filterGroupId
integer <int64>
object (UtmLogstashFilterGroup)
systemOwner
boolean
moduleName
string
filterVersion
string
active
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "filterName": "string",
  • "logstashFilter": "string",
  • "filterGroupId": 0,
  • "group": {
    },
  • "systemOwner": true,
  • "moduleName": "string",
  • "filterVersion": "string",
  • "active": true
}

getLogstashFilter

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

Responses

deleteLogstashFilter

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

Responses

filtersByPipelineId

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
pipelineId
required
integer <int64>

Responses

log-analyzer-resource

getAllLogAnalyzerQueries

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

Responses

updateLogAnalyzerQuery

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
description
string [ 0 .. 255 ] characters
owner
string
creationDate
string <date-time>
modificationDate
string <date-time>
dataOrigin
string
idPattern
integer <int64>
Array of objects (DataColumn)
Array of objects (FilterType)
object (UtmIndexPattern)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "dataOrigin": "string",
  • "idPattern": 0,
  • "columnsType": [
    ],
  • "filtersType": [
    ],
  • "pattern": {
    }
}

createLogAnalyzerQuery

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string [ 0 .. 100 ] characters
description
string [ 0 .. 255 ] characters
owner
string
creationDate
string <date-time>
modificationDate
string <date-time>
dataOrigin
string
idPattern
integer <int64>
Array of objects (DataColumn)
Array of objects (FilterType)
object (UtmIndexPattern)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "dataOrigin": "string",
  • "idPattern": 0,
  • "columnsType": [
    ],
  • "filtersType": [
    ],
  • "pattern": {
    }
}

getTopXValues

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
indexPattern
required
string
field
required
string
top
required
integer <int32>
query Parameters
required
object (Pageable)
Request Body schema: application/json
Array
operator
string
Enum: "IS" "IS_NOT" "CONTAIN" "DOES_NOT_CONTAIN" "IS_ONE_OF" "IS_NOT_ONE_OF" "IS_ONE_OF_TERMS" "EXIST" "DOES_NOT_EXIST" "IS_BETWEEN" "IS_NOT_BETWEEN" "IS_IN_FIELDS" "IS_NOT_IN_FIELDS" "ENDS_WITH" "NOT_ENDS_WITH" "START_WITH" "NOT_START_WITH" "IS_GREATER_THAN" "IS_LESS_THAN_OR_EQUALS"
field
string
value
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

getChartViewData

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
indexPattern
string
Array of objects (FilterType)
interval
string
Enum: "Second" "Minute" "Hour" "Day" "Week" "Month" "Quarter" "Year"
top
integer <int32>
field
string
fieldDataType
string

Responses

Request samples

Content type
application/json
{
  • "indexPattern": "string",
  • "filters": [
    ],
  • "interval": "Second",
  • "top": 0,
  • "field": "string",
  • "fieldDataType": "string"
}

getLogAnalyzerQuery

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

Responses

deleteLogAnalyzerQuery

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

Responses

index-policy-resource

getPolicy

Authorizations:
(bearerAuthApiKeyAuth)

Responses

updateIndexPolicy

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
snapshotActive
required
boolean
deleteAfter
required
string

Responses

Request samples

Content type
application/json
{
  • "snapshotActive": true,
  • "deleteAfter": "string"
}

utm-incident-action-command-resource

getAllIncidentActionCommands

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

Responses

updateIncidentActionCommand

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
actionId
required
integer <int64>
osPlatform
string
command
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "actionId": 0,
  • "osPlatform": "string",
  • "command": "string"
}

createIncidentActionCommand

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
actionId
required
integer <int64>
osPlatform
string
command
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "actionId": 0,
  • "osPlatform": "string",
  • "command": "string"
}

deleteIncidentActionCommand

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

Responses

utm-images-resource

updateImage

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
shortName
string
Enum: "LOGIN" "HEADER" "REPORT" "REPORT_COVER"
tooltipText
string
systemImg
string
userImg
string

Responses

Request samples

Content type
application/json
{
  • "shortName": "LOGIN",
  • "tooltipText": "string",
  • "systemImg": "string",
  • "userImg": "string"
}

getImage

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
shortName
required
string
Enum: "LOGIN" "HEADER" "REPORT" "REPORT_COVER"

Responses

reset

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getAllImages

Authorizations:
(bearerAuthApiKeyAuth)

Responses

utm-compliance-standard-resource

getAllComplianceStandard

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

Responses

updateComplianceStandard

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
standardName
string
standardDescription
string
systemOwner
boolean

Responses

Request samples

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

createComplianceStandard

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
standardName
string
standardDescription
string
systemOwner
boolean

Responses

Request samples

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

getComplianceStandard

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

Responses

deleteComplianceStandard

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

Responses

utm-compliance-standard-section-resource

getAllComplianceStandardSection

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

Responses

updateComplianceStandardSection

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
standardId
integer <int64>
standardSectionName
string
standardSectionDescription
string
object (UtmComplianceStandard)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "standardId": 0,
  • "standardSectionName": "string",
  • "standardSectionDescription": "string",
  • "standard": {
    }
}

createComplianceStandardSection

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
standardId
integer <int64>
standardSectionName
string
standardSectionDescription
string
object (UtmComplianceStandard)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "standardId": 0,
  • "standardSectionName": "string",
  • "standardSectionDescription": "string",
  • "standard": {
    }
}

getComplianceStandardSection

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

Responses

deleteComplianceStandardSection

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

Responses

getSectionsWithReports

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
standardId
required
integer <int64>

Responses

utm-compliance-report-config-resource

getAllComplianceReportConfig

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

Responses

updateComplianceReportConfig

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
configSolution
string
configReportResourceUrl
string
configReportRequestType
string
configReportPageable
boolean
configReportFilterByTime
boolean
configReportDataOrigin
string
configReportExportCsvUrl
string
standardSectionId
integer <int64>
configReportEditable
boolean
dashboardId
integer <int64>
configType
string
Enum: "CUSTOM" "TEMPLATE"
configUrl
string
Array of objects (UtmDashboardVisualization)
object (UtmComplianceStandardSection)
object (UtmDashboard)
Array of objects (DataColumn)
Array of objects (FilterType)
Array of objects (RequestParamFilter)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "configSolution": "string",
  • "configReportResourceUrl": "string",
  • "configReportRequestType": "string",
  • "configReportPageable": true,
  • "configReportFilterByTime": true,
  • "configReportDataOrigin": "string",
  • "configReportExportCsvUrl": "string",
  • "standardSectionId": 0,
  • "configReportEditable": true,
  • "dashboardId": 0,
  • "configType": "CUSTOM",
  • "configUrl": "string",
  • "dashboard": [
    ],
  • "section": {
    },
  • "associatedDashboard": {
    },
  • "columns": [
    ],
  • "requestBodyFilters": [
    ],
  • "requestParamFilters": [
    ]
}

createComplianceReportConfig

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
configSolution
string
configReportResourceUrl
string
configReportRequestType
string
configReportPageable
boolean
configReportFilterByTime
boolean
configReportDataOrigin
string
configReportExportCsvUrl
string
standardSectionId
integer <int64>
configReportEditable
boolean
dashboardId
integer <int64>
configType
string
Enum: "CUSTOM" "TEMPLATE"
configUrl
string
Array of objects (UtmDashboardVisualization)
object (UtmComplianceStandardSection)
object (UtmDashboard)
Array of objects (DataColumn)
Array of objects (FilterType)
Array of objects (RequestParamFilter)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "configSolution": "string",
  • "configReportResourceUrl": "string",
  • "configReportRequestType": "string",
  • "configReportPageable": true,
  • "configReportFilterByTime": true,
  • "configReportDataOrigin": "string",
  • "configReportExportCsvUrl": "string",
  • "standardSectionId": 0,
  • "configReportEditable": true,
  • "dashboardId": 0,
  • "configType": "CUSTOM",
  • "configUrl": "string",
  • "dashboard": [
    ],
  • "section": {
    },
  • "associatedDashboard": {
    },
  • "columns": [
    ],
  • "requestBodyFilters": [
    ],
  • "requestParamFilters": [
    ]
}

importReports

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

Responses

Request samples

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

getComplianceReportConfig

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

Responses

deleteComplianceReportConfig

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

Responses

getReportsByFilters

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
standardId
integer <int64>
solution
string
sectionId
integer <int64>
expandDashboard
boolean
required
object (Pageable)

Responses

utm-compliance-report-schedule-resource

updateUtmComplianceReportSchedule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
userId
integer <int64>
complianceId
integer <int64>
scheduleString
string [ 0 .. 250 ] characters
urlWithParams
string
Array of objects (IndexPatternWithFilterType)
object (UtmComplianceReportConfig)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "userId": 0,
  • "complianceId": 0,
  • "scheduleString": "string",
  • "urlWithParams": "string",
  • "filterDef": [
    ],
  • "compliance": {
    }
}

createUtmComplianceReportSchedule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
userId
integer <int64>
complianceId
integer <int64>
scheduleString
string [ 0 .. 250 ] characters
urlWithParams
string
Array of objects (IndexPatternWithFilterType)
object (UtmComplianceReportConfig)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "userId": 0,
  • "complianceId": 0,
  • "scheduleString": "string",
  • "urlWithParams": "string",
  • "filterDef": [
    ],
  • "compliance": {
    }
}

getAllUtmComplianceReportSchedules

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

Responses

getUtmComplianceReportScheduleById

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

Responses

deleteUtmComplianceReportSchedule

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

Responses

authority-resource

getAllAuthority

Authorizations:
(bearerAuthApiKeyAuth)

Responses

updateAuthority

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
name
required
string [ 0 .. 50 ] characters
nameShow
required
string [ 0 .. 50 ] characters

Responses

Request samples

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

createAuthority

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
name
required
string [ 0 .. 50 ] characters
nameShow
required
string [ 0 .. 50 ] characters

Responses

Request samples

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

deleteAuthority

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
name
required
string

Responses

utm-alert-tag-rule-resource

getAlertTagRulesByFilter

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

Responses

updateAlertTagRule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string
description
required
string
required
Array of objects (FilterType)
required
Array of objects (AlertTagVM)
active
boolean
deleted
boolean
createdBy
string
createdDate
string <date-time>
lastModifiedBy
string
lastModifiedDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "conditions": [
    ],
  • "tags": [
    ],
  • "active": true,
  • "deleted": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z"
}

createAlertTagRule

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
name
required
string
description
required
string
required
Array of objects (FilterType)
required
Array of objects (AlertTagVM)
active
boolean
deleted
boolean
createdBy
string
createdDate
string <date-time>
lastModifiedBy
string
lastModifiedDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "conditions": [
    ],
  • "tags": [
    ],
  • "active": true,
  • "deleted": true,
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z"
}

getAlertTagRule

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

Responses

deleteAlertTagRule

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

Responses

getAlertTagRulesByIds

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

Responses

agent-manager-group-resource

updateAgentGroupDTO

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
groupName
required
string
groupDescription
string
id
integer <int64>

Responses

Request samples

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

createAgentGroupDTO

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
groupName
required
string
groupDescription
string
id
integer <int64>

Responses

Request samples

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

listAgentGroups

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
searchQuery
string
sortBy
string

Responses

deleteAgentGroupDTO

Authorizations:
(bearerAuthApiKeyAuth)
path Parameters
id
required
string

Responses

utm-incident-note-resource

getAllUtmIncidentNotes

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

Responses

createUtmIncidentNote

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
incidentId
required
integer <int64>
noteText
required
string

Responses

Request samples

Content type
application/json
{
  • "incidentId": 0,
  • "noteText": "string"
}

utm-incident-job-resource

getAllUtmIncidentJobs

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

Responses

createIncidentJob

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
actionId
integer <int64>
params
string
agent
string
status
integer <int32>
jobResult
string
originId
required
integer <int32>
originType
required
string
createdDate
string <date-time>
modifiedDate
string <date-time>
createdUser
string
modifiedUser
string
object (UtmIncidentAction)
statusLabel
string
Enum: "PENDING" "RUNNING" "EXECUTED" "ERROR"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "actionId": 0,
  • "params": "string",
  • "agent": "string",
  • "status": 0,
  • "jobResult": "string",
  • "originId": 0,
  • "originType": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdUser": "string",
  • "modifiedUser": "string",
  • "action": {
    },
  • "statusLabel": "PENDING"
}

getUtmIncidentJob

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

Responses

deleteUtmIncidentJob

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

Responses

countUtmIncidentJobs

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

Responses

utm-getting-started-resource

initSteps

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
inSaas
required
boolean

Responses

Request samples

Content type
application/json
{
  • "inSaas": true
}

getSteps

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

Responses

completeStep

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
step
required
string

Responses

utm-alert-resource

updateAlertTags

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
alertIds
required
Array of strings
tags
Array of strings
createRule
required
boolean

Responses

Request samples

Content type
application/json
{
  • "alertIds": [
    ],
  • "tags": [
    ],
  • "createRule": true
}

updateAlertStatus

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

Responses

Request samples

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

updateAlertNotes

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
alertId
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

convertToIncident

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
eventIds
required
Array of strings
incidentName
required
string^[^"]*$
incidentId
required
integer <int32>
incidentSource
required
string

Responses

Request samples

Content type
application/json
{
  • "eventIds": [
    ],
  • "incidentName": "string",
  • "incidentId": 0,
  • "incidentSource": "string"
}

countOpenAlerts

Authorizations:
(bearerAuthApiKeyAuth)

Responses

utm-soc-ai-resource

sendData

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

Responses

Request samples

Content type
application/json
[
  • "string"
]

utm-stack-resource

encrypt

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

Responses

Request samples

Content type
application/json
"string"

ping

Authorizations:
(bearerAuthApiKeyAuth)

Responses

isInDevelop

Authorizations:
(bearerAuthApiKeyAuth)

Responses

healthCheck

Authorizations:
(bearerAuthApiKeyAuth)

Responses

dateFormat

Authorizations:
(bearerAuthApiKeyAuth)

Responses

elasticsearch-resource

search

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
top
required
integer <int32>
indexPattern
required
string
required
object (Pageable)
Request Body schema: application/json
Array
operator
string
Enum: "IS" "IS_NOT" "CONTAIN" "DOES_NOT_CONTAIN" "IS_ONE_OF" "IS_NOT_ONE_OF" "IS_ONE_OF_TERMS" "EXIST" "DOES_NOT_EXIST" "IS_BETWEEN" "IS_NOT_BETWEEN" "IS_IN_FIELDS" "IS_NOT_IN_FIELDS" "ENDS_WITH" "NOT_ENDS_WITH" "START_WITH" "NOT_START_WITH" "IS_GREATER_THAN" "IS_LESS_THAN_OR_EQUALS"
field
string
value
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

searchToCsv

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
required
Array of objects (DataColumn)
Array of objects (FilterType)
top
required
integer <int32>
indexPattern
required
string

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ],
  • "filters": [
    ],
  • "top": 0,
  • "indexPattern": "string"
}

getFieldValuesWithCount

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
Array of objects (FilterType)
field
string
top
integer <int32>
index
required
string
orderByCount
boolean
sortAsc
boolean

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "field": "string",
  • "top": 0,
  • "index": "string",
  • "orderByCount": true,
  • "sortAsc": true
}

deleteIndex

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

Responses

Request samples

Content type
application/json
[
  • "string"
]

genericSearch

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (Pageable)
Request Body schema: application/json
required
index
required
string
Array of objects (FilterType)
top
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "index": "string",
  • "filters": [
    ],
  • "top": 0
}

getFieldValues

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
keyword
required
string
indexPattern
required
string

Responses

getIndexProperties

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
indexPattern
required
string

Responses

getAllIndexes

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
includeSystemIndex
boolean
Default: false
pattern
string
required
object (Pageable)

Responses

getClusterStatus

Authorizations:
(bearerAuthApiKeyAuth)

Responses

account-resource

isAuthenticated

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getAccount

Authorizations:
(bearerAuthApiKeyAuth)

Responses

saveAccount

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
id
integer <int64>
login
required
string [ 1 .. 50 ] characters ^[_.@A-Za-z0-9-]*$
firstName
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
email
string [ 5 .. 254 ] characters
imageUrl
string [ 0 .. 256 ] characters
activated
boolean
langKey
string [ 2 .. 6 ] characters
createdBy
string
createdDate
string <date-time>
lastModifiedBy
string
lastModifiedDate
string <date-time>
authorities
Array of strings unique
tfaSecret
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "login": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "imageUrl": "string",
  • "activated": true,
  • "langKey": "string",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedBy": "string",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "authorities": [
    ],
  • "tfaSecret": "string"
}

requestPasswordReset

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

Responses

Request samples

Content type
application/json
"string"

finishPasswordReset

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
key
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "newPassword": "string"
}

changePassword

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
currentPassword
string
newPassword
string

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string"
}

user-jwt-controller

authorize

Authorizations:
(bearerAuthApiKeyAuth)
Request Body schema: application/json
required
username
required
string [ 1 .. 50 ] characters
password
required
string [ 4 .. 100 ] characters
rememberMe
boolean

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "rememberMe": true
}

authorizeFederationServiceManager

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

Responses

Request samples

Content type
application/json
"string"

verifyCode

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
code
required
string

Responses

checkPassword

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
password
required
string
checkUUID
required
string

Responses

audit-resource

getAll_1

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (Pageable)
fromDate
required
string <date>
toDate
required
string <date>

Responses

get

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

Responses

utm-auditor-users-resource

getUtmAuditorUsers

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
sid
required
string
from
required
string
to
required
string
indexPattern
required
string
sort
required
string
page
required
string
size
required
string
required
object (Pageable)

Responses

getAllUtmAuditorUsers

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
required
object (Pageable)
sourceId
required
integer <int64>

Responses

utm-incident-history-resource

getAllUtmIncidentHistories

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

Responses

getUtmIncidentHistory

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

Responses

countUtmIncidentHistories

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

Responses

utm-configuration-section-resource

getConfigurationSections

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
id.greaterThan
integer <int64>
id.lessThan
integer <int64>
id.greaterThanOrEqual
integer <int64>
id.lessThanOrEqual
integer <int64>
id.equals
integer <int64>
id.notEquals
integer <int64>
id.specified
boolean
id.in
Array of integers <int64> [ items <int64 > ]
id.notIn
Array of integers <int64> [ items <int64 > ]
section.contains
string
section.doesNotContain
string
section.equals
string
section.notEquals
string
section.specified
boolean
section.in
Array of strings
section.notIn
Array of strings
shortName.equals
string
Enum: "SMS" "EMAIL" "TFA" "ALERTS" "DATE_SETTINGS"
shortName.notEquals
string
Enum: "SMS" "EMAIL" "TFA" "ALERTS" "DATE_SETTINGS"
shortName.specified
boolean
shortName.in
Array of strings
Items Enum: "SMS" "EMAIL" "TFA" "ALERTS" "DATE_SETTINGS"
shortName.notIn
Array of strings
Items Enum: "SMS" "EMAIL" "TFA" "ALERTS" "DATE_SETTINGS"
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

utm-client-resource

getAllUtmClients

Authorizations:
(bearerAuthApiKeyAuth)

Responses

getUtmClient

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

Responses

utm-asset-types-resource

getAssetTypes

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

Responses

utm-alert-response-rule-history-resource

getAllAlertResponseRuleHistories

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
id.greaterThan
integer <int64>
id.lessThan
integer <int64>
id.greaterThanOrEqual
integer <int64>
id.lessThanOrEqual
integer <int64>
id.equals
integer <int64>
id.notEquals
integer <int64>
id.specified
boolean
id.in
Array of integers <int64> [ items <int64 > ]
id.notIn
Array of integers <int64> [ items <int64 > ]
ruleId.greaterThan
integer <int64>
ruleId.lessThan
integer <int64>
ruleId.greaterThanOrEqual
integer <int64>
ruleId.lessThanOrEqual
integer <int64>
ruleId.equals
integer <int64>
ruleId.notEquals
integer <int64>
ruleId.specified
boolean
ruleId.in
Array of integers <int64> [ items <int64 > ]
ruleId.notIn
Array of integers <int64> [ items <int64 > ]
createdDate.greaterThan
string <date-time>
createdDate.lessThan
string <date-time>
createdDate.greaterThanOrEqual
string <date-time>
createdDate.lessThanOrEqual
string <date-time>
createdDate.equals
string <date-time>
createdDate.notEquals
string <date-time>
createdDate.specified
boolean
createdDate.in
Array of strings <date-time> [ items <date-time > ]
createdDate.notIn
Array of strings <date-time> [ items <date-time > ]
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

utm-alert-response-rule-execution-resource

getAllAlertResponseRuleExecutions

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

Responses

overview-resource

topWindowsEvents

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string
to
required
string
top
required
integer <int32>

Responses

topAlerts

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string
to
required
string
top
required
integer <int32>

Responses

topAlertsByCategory

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string
to
required
string
top
required
integer <int32>

Responses

eventsInTime

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string
to
required
string
interval
required
string
Enum: "Second" "Minute" "Hour" "Day" "Week" "Month" "Quarter" "Year"

Responses

countEventsByType

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string
to
required
string
top
required
integer <int32>

Responses

countAlertsTodayAndLastWeek

Authorizations:
(bearerAuthApiKeyAuth)

Responses

countAlertsByStatus

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string
to
required
string

Responses

countAlertsBySeverity

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string
to
required
string
top
required
integer <int32>

Responses

pdf-generator-resource

getPdfReportInBytes

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
url
required
string
accessType
required
string
Enum: "PDF_TYPE_INTERNAL" "PDF_TYPE_TOKEN"
filename
required
string
header Parameters
Authorization
required
string

Responses

utm-federation-service-client-resource

getFederationServiceManagerToken

Authorizations:
(bearerAuthApiKeyAuth)

Responses

generateApiToken

Authorizations:
(bearerAuthApiKeyAuth)

Responses

custom-reports-resource

buildThreatActivityForIncidents

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string <date-time>
to
required
string <date-time>
top
required
integer <int32>

Responses

buildThreatActivityForAlerts

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string <date-time>
to
required
string <date-time>
top
required
integer <int32>

Responses

buildAssetManagement

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
from
required
string <date-time>
to
required
string <date-time>
top
required
integer <int32>

Responses

agent-manager-resource

canRunCommand_1

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
hostname
required
string

Responses

listAgents

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
searchQuery
string
sortBy
string

Responses

listAgentsWithCommands

Authorizations:
(bearerAuthApiKeyAuth)

Responses

listAgentCommands

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
searchQuery
string
sortBy
string

Responses

getAgentByHostname

Authorizations:
(bearerAuthApiKeyAuth)
query Parameters
hostname
required
string

Responses