logs-resource
utm-visualization-resource
utm-server-resource
utm-server-module-resource
utm-schedule-resource
utm-report-resource
utm-report-section-resource
utm-ports-resource
utm-network-scan-resource
- GETGet apiutm network scans
- PUTPut apiutm network scans
- PUTPut apiutm network scansupdatetype
- PUTPut apiutm network scansupdategroup
- POSTPost apiutm network scanssaveorupdatecustomasset
- GETGet apiutm network scans 1
- GETGet apiutm network scanssearchpropertyvalues
- GETGet apiutm network scanssearch by filters
- GETGet apiutm network scansgetnetworkscanreport
- GETGet apiutm network scanscount
- GETGet apiutm network scanscountnewassets
- GETGet apiutm network scanscan run command
- GETGet apiutm network scansagent os platform
- DELDelete apiutm network scansdeletecustomasset
utm-module-resource
utm-menu-authority-resource
utm-logstash-filter-group-resource
utm-integration-resource
utm-integration-conf-resource
utm-index-pattern-resource
utm-incident-resource
utm-incident-variable-resource
utm-incident-alert-resource
utm-incident-action-resource
utm-data-source-config-resource
utm-data-input-status-resource
utm-dashboard-resource
utm-dashboard-visualization-resource
utm-dashboard-authority-resource
utm-configuration-parameter-resource
utm-module-group-resource
utm-asset-metrics-resource
utm-asset-group-resource
utm-alert-tag-resource
utm-alert-response-rule-resource
utm-alert-log-resource
user-resource
utm-collector-resource
utm-module-group-configuration-resource
utm-menu-resource
utm-logstash-pipeline-resource
utm-logstash-input-resource
utm-logstash-filter-resource
log-analyzer-resource
index-policy-resource
utm-incident-action-command-resource
utm-images-resource
utm-compliance-standard-resource
utm-compliance-standard-section-resource
utm-compliance-report-config-resource
utm-compliance-report-schedule-resource
utm-alert-tag-rule-resource
agent-manager-group-resource
utm-incident-note-resource
utm-incident-job-resource
utm-getting-started-resource
utm-alert-resource
utm-soc-ai-resource
utm-stack-resource
elasticsearch-resource
- POSTPost apielasticsearchsearch
- POSTPost apielasticsearchsearchcsv
- POSTPost apielasticsearchpropertyvalues with count
- POSTPost apielasticsearchindexdelete index
- POSTPost apielasticsearchgeneric search
- GETGet apielasticsearchpropertyvalues
- GETGet apielasticsearchindexproperties
- GETGet apielasticsearchindexall
- GETGet apielasticsearchclusterstatus
account-resource
user-jwt-controller
audit-resource
utm-auditor-users-resource
utm-incident-history-resource
utm-configuration-section-resource
utm-client-resource
utm-asset-types-resource
utm-alert-response-rule-history-resource
utm-alert-response-rule-execution-resource
overview-resource
- GETGet apioverviewtop windows events
- GETGet apioverviewtop alerts
- GETGet apioverviewtop alerts by category
- GETGet apioverviewevents in time
- GETGet apioverviewcount events by type
- GETGet apioverviewcount alerts today and last week
- GETGet apioverviewcount alerts by status
- GETGet apioverviewcount alerts by severity
pdf-generator-resource
utm-federation-service-client-resource
custom-reports-resource
utm-collector-resource
Get apicollectors list
GET
/
api
/
collectors-list
{
"collectors": [
{
"id": 123,
"status": "ONLINE",
"collectorKey": "<string>",
"ip": "<string>",
"hostname": "<string>",
"version": "<string>",
"module": "AS_400",
"lastSeen": "<string>",
"groupId": "<string>",
"group": {
"id": 123,
"groupName": "<string>",
"groupDescription": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"metrics": [
{
"id": "<string>",
"assetName": "<string>",
"metric": "<string>",
"amount": 123
}
],
"assets": [
{
"id": 123,
"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": 123,
"discoveredAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"assetNotes": "<string>",
"serverName": "<string>",
"groupId": 123,
"registeredMode": "CUSTOM",
"isAgent": true,
"registerIp": "<string>",
"updateLevel": "DATASOURCE",
"assetType": {
"id": 123,
"typeName": "<string>"
},
"ports": [
{
"id": 123,
"scanId": 123,
"port": 123,
"tcp": "<string>",
"udp": "<string>"
}
],
"metrics": [
{
"id": "<string>",
"assetName": "<string>",
"metric": "<string>",
"amount": 123
}
],
"dataInputList": [
{
"id": "<string>",
"source": "<string>",
"dataType": "<string>",
"timestamp": 123,
"median": 123,
"down": true
}
],
"assetGroup": {},
"uuid": 123
}
],
"collectors": [
{
"id": 123,
"status": "<string>",
"collectorKey": "<string>",
"ip": "<string>",
"hostname": "<string>",
"version": "<string>",
"module": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"groupId": 123,
"assetGroup": {},
"active": true
}
],
"type": "<string>"
},
"active": true
}
],
"total": 123
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Available options:
AS_400
Response
200 - */*
OK
Available options:
ONLINE
, OFFLINE
, UNKNOWN
Available options:
AS_400
Maximum length:
100
Maximum length:
255
Maximum length:
255
Maximum length:
255
Maximum length:
100
Maximum length:
20
Maximum length:
20
Maximum length:
100
Maximum length:
100
Maximum length:
255
Maximum length:
500
Available options:
NEW
, CHECK
, MISSING
Maximum length:
255
Available options:
CUSTOM
, DISCOVERED
, DYNAMIC
Maximum length:
50
Available options:
DATASOURCE
, SCANNER
, AGENT
Maximum length:
256
Maximum length:
50
Maximum length:
100
Maximum length:
100
{
"collectors": [
{
"id": 123,
"status": "ONLINE",
"collectorKey": "<string>",
"ip": "<string>",
"hostname": "<string>",
"version": "<string>",
"module": "AS_400",
"lastSeen": "<string>",
"groupId": "<string>",
"group": {
"id": 123,
"groupName": "<string>",
"groupDescription": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"metrics": [
{
"id": "<string>",
"assetName": "<string>",
"metric": "<string>",
"amount": 123
}
],
"assets": [
{
"id": 123,
"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": 123,
"discoveredAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"assetNotes": "<string>",
"serverName": "<string>",
"groupId": 123,
"registeredMode": "CUSTOM",
"isAgent": true,
"registerIp": "<string>",
"updateLevel": "DATASOURCE",
"assetType": {
"id": 123,
"typeName": "<string>"
},
"ports": [
{
"id": 123,
"scanId": 123,
"port": 123,
"tcp": "<string>",
"udp": "<string>"
}
],
"metrics": [
{
"id": "<string>",
"assetName": "<string>",
"metric": "<string>",
"amount": 123
}
],
"dataInputList": [
{
"id": "<string>",
"source": "<string>",
"dataType": "<string>",
"timestamp": 123,
"median": 123,
"down": true
}
],
"assetGroup": {},
"uuid": 123
}
],
"collectors": [
{
"id": 123,
"status": "<string>",
"collectorKey": "<string>",
"ip": "<string>",
"hostname": "<string>",
"version": "<string>",
"module": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"groupId": 123,
"assetGroup": {},
"active": true
}
],
"type": "<string>"
},
"active": true
}
],
"total": 123
}