USM Anywhereâ„¢ API References
version 2.0
baseUri https://your-subdomain.alienvault.cloud/api/2.0
protocols HTTPS
mediaType application/json
Getting Started
AT&T Cybersecurity publishes REST APIs for USM Anywhere that provide a programmatic interface that will allow you to access your data directly from your own applications and extensions. To get started, see documentation on the USM Anywhere APIs.
Types
HalLink
Properties
TYPE DEFINITION
{
"name": "HalLink",
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
}
}AlarmLinks
Properties
TYPE DEFINITION
{
"name": "AlarmLinks",
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": true
}
}
}AlarmSouceLinks
Properties
TYPE DEFINITION
{
"name": "AlarmSouceLinks",
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
}
}AlarmDestinationLinks
Properties
TYPE DEFINITION
{
"name": "AlarmDestinationLinks",
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
}
}EventLinks
Properties
TYPE DEFINITION
{
"name": "EventLinks",
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
}
}PageLinks
Properties
TYPE DEFINITION
{
"name": "PageLinks",
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": true
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "first",
"displayName": "first",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "last",
"displayName": "last",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "next",
"displayName": "next",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
},
"prev": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "prev",
"displayName": "prev",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
}
}AlarmSource
Properties
TYPE DEFINITION
{
"name": "AlarmSource",
"type": "object",
"properties": {
"address": {
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"hostname": {
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"fqdn": {
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"asset_id": {
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"organisation": {
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"country": {
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"canonical": {
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"name": {
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"event_count": {
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
},
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmSouceLinks",
"displayName": "AlarmSouceLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"self": {
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false
}
}
},
"originalType": "AlarmSouceLinks",
"required": false
}
}
}AlarmDestination
Properties
TYPE DEFINITION
{
"name": "AlarmDestination",
"type": "object",
"properties": {
"address": {
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"hostname": {
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"fqdn": {
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"asset_id": {
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"organisation": {
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"country": {
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"canonical": {
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"name": {
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"event_count": {
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
},
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmDestinationLinks",
"displayName": "AlarmDestinationLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"self": {
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false
}
}
},
"originalType": "AlarmDestinationLinks",
"required": false
}
}
}AlarmEvent
Properties
TYPE DEFINITION
{
"name": "AlarmEvent",
"type": "object",
"properties": {
"uuid": {
"type": "string",
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"has_alarm": {
"type": "boolean",
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"needs_enrichment": {
"type": "boolean",
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"priority": {
"type": "integer",
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"suppressed": {
"type": "boolean",
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_address": {
"type": "string",
"name": "source_address",
"displayName": "source_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_asset_id": {
"type": "string",
"name": "source_asset_id",
"displayName": "source_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_canonical": {
"type": "string",
"name": "source_canonical",
"displayName": "source_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_country": {
"type": "string",
"name": "source_country",
"displayName": "source_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_fqdn": {
"type": "string",
"name": "source_fqdn",
"displayName": "source_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_hostname": {
"type": "string",
"name": "source_hostname",
"displayName": "source_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_name": {
"type": "string",
"name": "source_name",
"displayName": "source_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_organisation": {
"type": "string",
"name": "source_organisation",
"displayName": "source_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_address": {
"type": "string",
"name": "destination_address",
"displayName": "destination_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_asset_id": {
"type": "string",
"name": "destination_asset_id",
"displayName": "destination_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_canonical": {
"type": "string",
"name": "destination_canonical",
"displayName": "destination_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_country": {
"type": "string",
"name": "destination_country",
"displayName": "destination_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_fqdn": {
"type": "string",
"name": "destination_fqdn",
"displayName": "destination_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_hostname": {
"type": "string",
"name": "destination_hostname",
"displayName": "destination_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_name": {
"type": "string",
"name": "destination_name",
"displayName": "destination_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_organisation": {
"type": "string",
"name": "destination_organisation",
"displayName": "destination_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
},
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "EventLinks",
"displayName": "EventLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"self": {
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false
}
}
},
"originalType": "EventLinks",
"required": false
}
}
}Alarm
Properties
TYPE DEFINITION
{
"name": "Alarm",
"type": "object",
"properties": {
"uuid": {
"type": "string",
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "uuid"
},
"alarm_labels": {
"type": "array",
"items": {
"type": "string"
},
"name": "alarm_labels",
"displayName": "alarm_labels",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "alarm_labels"
},
"has_alarm": {
"type": "boolean",
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "has_alarm"
},
"needs_enrichment": {
"type": "boolean",
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "needs_enrichment"
},
"packet_data": {
"type": "array",
"items": {
"type": "string"
},
"name": "packet_data",
"displayName": "packet_data",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "packet_data"
},
"priority": {
"type": "integer",
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "priority"
},
"suppressed": {
"type": "boolean",
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "suppressed"
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": [
{
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "address"
},
{
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "hostname"
},
{
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "fqdn"
},
{
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "asset_id"
},
{
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "organisation"
},
{
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "country"
},
{
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "canonical"
},
{
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "name"
},
{
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "event_count"
},
{
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "self"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmDestinationLinks",
"displayName": "AlarmDestinationLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "self"
}
]
},
"originalType": "AlarmDestinationLinks",
"required": false,
"key": "_links"
}
],
"name": "AlarmDestination",
"displayName": "AlarmDestination",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmDestination",
"displayName": "AlarmDestination",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "address"
},
{
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "hostname"
},
{
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "fqdn"
},
{
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "asset_id"
},
{
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "organisation"
},
{
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "country"
},
{
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "canonical"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "name"
},
{
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "event_count"
},
{
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"AlarmDestinationLinks"
],
"required": false,
"key": "_links"
}
]
},
"originalType": "AlarmDestination"
},
"name": "destinations",
"displayName": "destinations",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destinations"
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": [
{
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "address"
},
{
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "hostname"
},
{
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "fqdn"
},
{
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "asset_id"
},
{
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "organisation"
},
{
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "country"
},
{
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "canonical"
},
{
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "name"
},
{
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "event_count"
},
{
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "self"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmSouceLinks",
"displayName": "AlarmSouceLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "self"
}
]
},
"originalType": "AlarmSouceLinks",
"required": false,
"key": "_links"
}
],
"name": "AlarmSource",
"displayName": "AlarmSource",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmSource",
"displayName": "AlarmSource",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "address"
},
{
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "hostname"
},
{
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "fqdn"
},
{
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "asset_id"
},
{
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "organisation"
},
{
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "country"
},
{
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "canonical"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "name"
},
{
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "event_count"
},
{
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"AlarmSouceLinks"
],
"required": false,
"key": "_links"
}
]
},
"originalType": "AlarmSource"
},
"name": "sources",
"displayName": "sources",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "sources"
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": [
{
"type": "string",
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "uuid"
},
{
"type": "boolean",
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "has_alarm"
},
{
"type": "boolean",
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "needs_enrichment"
},
{
"type": "integer",
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "priority"
},
{
"type": "boolean",
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "suppressed"
},
{
"type": "string",
"name": "source_address",
"displayName": "source_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_address"
},
{
"type": "string",
"name": "source_asset_id",
"displayName": "source_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_asset_id"
},
{
"type": "string",
"name": "source_canonical",
"displayName": "source_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_canonical"
},
{
"type": "string",
"name": "source_country",
"displayName": "source_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_country"
},
{
"type": "string",
"name": "source_fqdn",
"displayName": "source_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_fqdn"
},
{
"type": "string",
"name": "source_hostname",
"displayName": "source_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_hostname"
},
{
"type": "string",
"name": "source_name",
"displayName": "source_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_name"
},
{
"type": "string",
"name": "source_organisation",
"displayName": "source_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_organisation"
},
{
"type": "string",
"name": "destination_address",
"displayName": "destination_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_address"
},
{
"type": "string",
"name": "destination_asset_id",
"displayName": "destination_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_asset_id"
},
{
"type": "string",
"name": "destination_canonical",
"displayName": "destination_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_canonical"
},
{
"type": "string",
"name": "destination_country",
"displayName": "destination_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_country"
},
{
"type": "string",
"name": "destination_fqdn",
"displayName": "destination_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_fqdn"
},
{
"type": "string",
"name": "destination_hostname",
"displayName": "destination_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_hostname"
},
{
"type": "string",
"name": "destination_name",
"displayName": "destination_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_name"
},
{
"type": "string",
"name": "destination_organisation",
"displayName": "destination_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_organisation"
},
{
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "self"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "EventLinks",
"displayName": "EventLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "self"
}
]
},
"originalType": "EventLinks",
"required": false,
"key": "_links"
}
],
"name": "AlarmEvent",
"displayName": "AlarmEvent",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmEvent",
"displayName": "AlarmEvent",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "uuid"
},
{
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true,
"key": "has_alarm"
},
{
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true,
"key": "needs_enrichment"
},
{
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": false,
"key": "priority"
},
{
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "suppressed"
},
{
"name": "source_address",
"displayName": "source_address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_address"
},
{
"name": "source_asset_id",
"displayName": "source_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_asset_id"
},
{
"name": "source_canonical",
"displayName": "source_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_canonical"
},
{
"name": "source_country",
"displayName": "source_country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_country"
},
{
"name": "source_fqdn",
"displayName": "source_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_fqdn"
},
{
"name": "source_hostname",
"displayName": "source_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_hostname"
},
{
"name": "source_name",
"displayName": "source_name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_name"
},
{
"name": "source_organisation",
"displayName": "source_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_organisation"
},
{
"name": "destination_address",
"displayName": "destination_address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_address"
},
{
"name": "destination_asset_id",
"displayName": "destination_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_asset_id"
},
{
"name": "destination_canonical",
"displayName": "destination_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_canonical"
},
{
"name": "destination_country",
"displayName": "destination_country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_country"
},
{
"name": "destination_fqdn",
"displayName": "destination_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_fqdn"
},
{
"name": "destination_hostname",
"displayName": "destination_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_hostname"
},
{
"name": "destination_name",
"displayName": "destination_name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_name"
},
{
"name": "destination_organisation",
"displayName": "destination_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_organisation"
},
{
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"EventLinks"
],
"required": false,
"key": "_links"
}
]
},
"originalType": "AlarmEvent"
},
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "events"
}
}
}EmbeddedAlarms
Properties
TYPE DEFINITION
{
"name": "EmbeddedAlarms",
"type": "object",
"properties": {
"alarms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"alarm_labels": {
"type": "array",
"items": {
"type": "string"
},
"name": "alarm_labels",
"displayName": "alarm_labels",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"has_alarm": {
"type": "boolean",
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"needs_enrichment": {
"type": "boolean",
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"packet_data": {
"type": "array",
"items": {
"type": "string"
},
"name": "packet_data",
"displayName": "packet_data",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"priority": {
"type": "integer",
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"suppressed": {
"type": "boolean",
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"hostname": {
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"fqdn": {
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"asset_id": {
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"organisation": {
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"country": {
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"canonical": {
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"name": {
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"event_count": {
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
},
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmDestinationLinks",
"displayName": "AlarmDestinationLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"self": {
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false
}
}
},
"originalType": "AlarmDestinationLinks",
"required": false
}
},
"name": "AlarmDestination",
"displayName": "AlarmDestination",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmDestination",
"displayName": "AlarmDestination",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"address": {
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"hostname": {
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"fqdn": {
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"asset_id": {
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"organisation": {
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"country": {
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"canonical": {
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"name": {
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"event_count": {
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true
},
"_links": {
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"AlarmDestinationLinks"
],
"required": false
}
}
},
"originalType": "AlarmDestination"
},
"name": "destinations",
"displayName": "destinations",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"hostname": {
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"fqdn": {
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"asset_id": {
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"organisation": {
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"country": {
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"canonical": {
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"name": {
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"event_count": {
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
},
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmSouceLinks",
"displayName": "AlarmSouceLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"self": {
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false
}
}
},
"originalType": "AlarmSouceLinks",
"required": false
}
},
"name": "AlarmSource",
"displayName": "AlarmSource",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmSource",
"displayName": "AlarmSource",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"address": {
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"hostname": {
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"fqdn": {
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"asset_id": {
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"organisation": {
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"country": {
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"canonical": {
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"name": {
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"event_count": {
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true
},
"_links": {
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"AlarmSouceLinks"
],
"required": false
}
}
},
"originalType": "AlarmSource"
},
"name": "sources",
"displayName": "sources",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"has_alarm": {
"type": "boolean",
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"needs_enrichment": {
"type": "boolean",
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"priority": {
"type": "integer",
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"suppressed": {
"type": "boolean",
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_address": {
"type": "string",
"name": "source_address",
"displayName": "source_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_asset_id": {
"type": "string",
"name": "source_asset_id",
"displayName": "source_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_canonical": {
"type": "string",
"name": "source_canonical",
"displayName": "source_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_country": {
"type": "string",
"name": "source_country",
"displayName": "source_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_fqdn": {
"type": "string",
"name": "source_fqdn",
"displayName": "source_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_hostname": {
"type": "string",
"name": "source_hostname",
"displayName": "source_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_name": {
"type": "string",
"name": "source_name",
"displayName": "source_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"source_organisation": {
"type": "string",
"name": "source_organisation",
"displayName": "source_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_address": {
"type": "string",
"name": "destination_address",
"displayName": "destination_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_asset_id": {
"type": "string",
"name": "destination_asset_id",
"displayName": "destination_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_canonical": {
"type": "string",
"name": "destination_canonical",
"displayName": "destination_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_country": {
"type": "string",
"name": "destination_country",
"displayName": "destination_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_fqdn": {
"type": "string",
"name": "destination_fqdn",
"displayName": "destination_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_hostname": {
"type": "string",
"name": "destination_hostname",
"displayName": "destination_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_name": {
"type": "string",
"name": "destination_name",
"displayName": "destination_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"destination_organisation": {
"type": "string",
"name": "destination_organisation",
"displayName": "destination_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"templated": {
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"href": {
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"templated": {
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
}
}
},
"originalType": "HalLink",
"required": false
}
},
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "EventLinks",
"displayName": "EventLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"self": {
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false
}
}
},
"originalType": "EventLinks",
"required": false
}
},
"name": "AlarmEvent",
"displayName": "AlarmEvent",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmEvent",
"displayName": "AlarmEvent",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"uuid": {
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"has_alarm": {
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true
},
"needs_enrichment": {
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true
},
"priority": {
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": false
},
"suppressed": {
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
},
"source_address": {
"name": "source_address",
"displayName": "source_address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"source_asset_id": {
"name": "source_asset_id",
"displayName": "source_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"source_canonical": {
"name": "source_canonical",
"displayName": "source_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"source_country": {
"name": "source_country",
"displayName": "source_country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"source_fqdn": {
"name": "source_fqdn",
"displayName": "source_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"source_hostname": {
"name": "source_hostname",
"displayName": "source_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"source_name": {
"name": "source_name",
"displayName": "source_name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"source_organisation": {
"name": "source_organisation",
"displayName": "source_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_address": {
"name": "destination_address",
"displayName": "destination_address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_asset_id": {
"name": "destination_asset_id",
"displayName": "destination_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_canonical": {
"name": "destination_canonical",
"displayName": "destination_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_country": {
"name": "destination_country",
"displayName": "destination_country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_fqdn": {
"name": "destination_fqdn",
"displayName": "destination_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_hostname": {
"name": "destination_hostname",
"displayName": "destination_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_name": {
"name": "destination_name",
"displayName": "destination_name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"destination_organisation": {
"name": "destination_organisation",
"displayName": "destination_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false
},
"_links": {
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"EventLinks"
],
"required": false
}
}
},
"originalType": "AlarmEvent"
},
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false
}
},
"name": "Alarm",
"displayName": "Alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "Alarm",
"displayName": "Alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": {
"uuid": {
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true
},
"alarm_labels": {
"name": "alarm_labels",
"displayName": "alarm_labels",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "string"
},
"has_alarm": {
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true
},
"needs_enrichment": {
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true
},
"packet_data": {
"name": "packet_data",
"displayName": "packet_data",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "string"
},
"priority": {
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": false
},
"suppressed": {
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false
},
"destinations": {
"name": "destinations",
"displayName": "destinations",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "AlarmDestination"
},
"sources": {
"name": "sources",
"displayName": "sources",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "AlarmSource"
},
"events": {
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "AlarmEvent"
}
}
},
"originalType": "Alarm"
},
"name": "alarms",
"displayName": "alarms",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
}
}
}Event
TYPE DEFINITION
{
"name": "Event",
"type": "object",
"properties": {}
}EmbeddedEvents
Properties
TYPE DEFINITION
{
"name": "EmbeddedEvents",
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"name": "Event",
"displayName": "Event",
"typePropertyKind": "TYPE_EXPRESSION",
"rawType": {
"name": "Event",
"displayName": "Event",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
]
},
"additionalProperties": true,
"originalType": "Event"
},
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
}
}
}PageDetail
Properties
TYPE DEFINITION
{
"name": "PageDetail",
"type": "object",
"properties": {
"size": {
"type": "integer",
"name": "size",
"displayName": "size",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"totalElements": {
"type": "integer",
"name": "totalElements",
"displayName": "totalElements",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"totalPages": {
"type": "integer",
"name": "totalPages",
"displayName": "totalPages",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
},
"number": {
"type": "integer",
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true
}
}
}AlarmPage
Properties
TYPE DEFINITION
{
"name": "AlarmPage",
"type": "object",
"properties": {
"_links": {
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": true,
"key": "self"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "first",
"displayName": "first",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "first"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "last",
"displayName": "last",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "last"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "next",
"displayName": "next",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "next"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "prev",
"displayName": "prev",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "prev"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "PageLinks",
"displayName": "PageLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": true,
"key": "self"
},
{
"name": "first",
"displayName": "first",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "first"
},
{
"name": "last",
"displayName": "last",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "last"
},
{
"name": "next",
"displayName": "next",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "next"
},
{
"name": "prev",
"displayName": "prev",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "prev"
}
]
},
"originalType": "PageLinks",
"required": true,
"key": "_links"
},
"_embedded": {
"type": "object",
"properties": [
{
"type": "array",
"items": {
"type": "object",
"properties": [
{
"type": "string",
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "uuid"
},
{
"type": "array",
"items": {
"type": "string"
},
"name": "alarm_labels",
"displayName": "alarm_labels",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "alarm_labels"
},
{
"type": "boolean",
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "has_alarm"
},
{
"type": "boolean",
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "needs_enrichment"
},
{
"type": "array",
"items": {
"type": "string"
},
"name": "packet_data",
"displayName": "packet_data",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "packet_data"
},
{
"type": "integer",
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "priority"
},
{
"type": "boolean",
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "suppressed"
},
{
"type": "array",
"items": {
"type": "object",
"properties": [
{
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "address"
},
{
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "hostname"
},
{
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "fqdn"
},
{
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "asset_id"
},
{
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "organisation"
},
{
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "country"
},
{
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "canonical"
},
{
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "name"
},
{
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "event_count"
},
{
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "self"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmDestinationLinks",
"displayName": "AlarmDestinationLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "self"
}
]
},
"originalType": "AlarmDestinationLinks",
"required": false,
"key": "_links"
}
],
"name": "AlarmDestination",
"displayName": "AlarmDestination",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmDestination",
"displayName": "AlarmDestination",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "address"
},
{
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "hostname"
},
{
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "fqdn"
},
{
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "asset_id"
},
{
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "organisation"
},
{
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "country"
},
{
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "canonical"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "name"
},
{
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "event_count"
},
{
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"AlarmDestinationLinks"
],
"required": false,
"key": "_links"
}
]
},
"originalType": "AlarmDestination"
},
"name": "destinations",
"displayName": "destinations",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destinations"
},
{
"type": "array",
"items": {
"type": "object",
"properties": [
{
"type": "string",
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "address"
},
{
"type": "string",
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "hostname"
},
{
"type": "string",
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "fqdn"
},
{
"type": "string",
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "asset_id"
},
{
"type": "string",
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "organisation"
},
{
"type": "string",
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "country"
},
{
"type": "string",
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "canonical"
},
{
"type": "string",
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "name"
},
{
"type": "integer",
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "event_count"
},
{
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "self"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmSouceLinks",
"displayName": "AlarmSouceLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "self"
}
]
},
"originalType": "AlarmSouceLinks",
"required": false,
"key": "_links"
}
],
"name": "AlarmSource",
"displayName": "AlarmSource",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmSource",
"displayName": "AlarmSource",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "address",
"displayName": "address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "address"
},
{
"name": "hostname",
"displayName": "hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "hostname"
},
{
"name": "fqdn",
"displayName": "fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "fqdn"
},
{
"name": "asset_id",
"displayName": "asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "asset_id"
},
{
"name": "organisation",
"displayName": "organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "organisation"
},
{
"name": "country",
"displayName": "country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "country"
},
{
"name": "canonical",
"displayName": "canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "canonical"
},
{
"name": "name",
"displayName": "name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "name"
},
{
"name": "event_count",
"displayName": "event_count",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "event_count"
},
{
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"AlarmSouceLinks"
],
"required": false,
"key": "_links"
}
]
},
"originalType": "AlarmSource"
},
"name": "sources",
"displayName": "sources",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "sources"
},
{
"type": "array",
"items": {
"type": "object",
"properties": [
{
"type": "string",
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "uuid"
},
{
"type": "boolean",
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "has_alarm"
},
{
"type": "boolean",
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "needs_enrichment"
},
{
"type": "integer",
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "priority"
},
{
"type": "boolean",
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "suppressed"
},
{
"type": "string",
"name": "source_address",
"displayName": "source_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_address"
},
{
"type": "string",
"name": "source_asset_id",
"displayName": "source_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_asset_id"
},
{
"type": "string",
"name": "source_canonical",
"displayName": "source_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_canonical"
},
{
"type": "string",
"name": "source_country",
"displayName": "source_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_country"
},
{
"type": "string",
"name": "source_fqdn",
"displayName": "source_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_fqdn"
},
{
"type": "string",
"name": "source_hostname",
"displayName": "source_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_hostname"
},
{
"type": "string",
"name": "source_name",
"displayName": "source_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_name"
},
{
"type": "string",
"name": "source_organisation",
"displayName": "source_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "source_organisation"
},
{
"type": "string",
"name": "destination_address",
"displayName": "destination_address",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_address"
},
{
"type": "string",
"name": "destination_asset_id",
"displayName": "destination_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_asset_id"
},
{
"type": "string",
"name": "destination_canonical",
"displayName": "destination_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_canonical"
},
{
"type": "string",
"name": "destination_country",
"displayName": "destination_country",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_country"
},
{
"type": "string",
"name": "destination_fqdn",
"displayName": "destination_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_fqdn"
},
{
"type": "string",
"name": "destination_hostname",
"displayName": "destination_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_hostname"
},
{
"type": "string",
"name": "destination_name",
"displayName": "destination_name",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_name"
},
{
"type": "string",
"name": "destination_organisation",
"displayName": "destination_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "destination_organisation"
},
{
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "self"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "EventLinks",
"displayName": "EventLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "self"
}
]
},
"originalType": "EventLinks",
"required": false,
"key": "_links"
}
],
"name": "AlarmEvent",
"displayName": "AlarmEvent",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "AlarmEvent",
"displayName": "AlarmEvent",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "uuid"
},
{
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true,
"key": "has_alarm"
},
{
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true,
"key": "needs_enrichment"
},
{
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": false,
"key": "priority"
},
{
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "suppressed"
},
{
"name": "source_address",
"displayName": "source_address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_address"
},
{
"name": "source_asset_id",
"displayName": "source_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_asset_id"
},
{
"name": "source_canonical",
"displayName": "source_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_canonical"
},
{
"name": "source_country",
"displayName": "source_country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_country"
},
{
"name": "source_fqdn",
"displayName": "source_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_fqdn"
},
{
"name": "source_hostname",
"displayName": "source_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_hostname"
},
{
"name": "source_name",
"displayName": "source_name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_name"
},
{
"name": "source_organisation",
"displayName": "source_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "source_organisation"
},
{
"name": "destination_address",
"displayName": "destination_address",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_address"
},
{
"name": "destination_asset_id",
"displayName": "destination_asset_id",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_asset_id"
},
{
"name": "destination_canonical",
"displayName": "destination_canonical",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_canonical"
},
{
"name": "destination_country",
"displayName": "destination_country",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_country"
},
{
"name": "destination_fqdn",
"displayName": "destination_fqdn",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_fqdn"
},
{
"name": "destination_hostname",
"displayName": "destination_hostname",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_hostname"
},
{
"name": "destination_name",
"displayName": "destination_name",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_name"
},
{
"name": "destination_organisation",
"displayName": "destination_organisation",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": false,
"key": "destination_organisation"
},
{
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"EventLinks"
],
"required": false,
"key": "_links"
}
]
},
"originalType": "AlarmEvent"
},
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "events"
}
],
"name": "Alarm",
"displayName": "Alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "Alarm",
"displayName": "Alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "uuid",
"displayName": "uuid",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "uuid"
},
{
"name": "alarm_labels",
"displayName": "alarm_labels",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "string",
"key": "alarm_labels"
},
{
"name": "has_alarm",
"displayName": "has_alarm",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true,
"key": "has_alarm"
},
{
"name": "needs_enrichment",
"displayName": "needs_enrichment",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": true,
"key": "needs_enrichment"
},
{
"name": "packet_data",
"displayName": "packet_data",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "string",
"key": "packet_data"
},
{
"name": "priority",
"displayName": "priority",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": false,
"key": "priority"
},
{
"name": "suppressed",
"displayName": "suppressed",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "suppressed"
},
{
"name": "destinations",
"displayName": "destinations",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "AlarmDestination",
"key": "destinations"
},
{
"name": "sources",
"displayName": "sources",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "AlarmSource",
"key": "sources"
},
{
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": false,
"items": "AlarmEvent",
"key": "events"
}
]
},
"originalType": "Alarm"
},
"name": "alarms",
"displayName": "alarms",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "alarms"
}
],
"name": "_embedded",
"displayName": "_embedded",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "EmbeddedAlarms",
"displayName": "EmbeddedAlarms",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "alarms",
"displayName": "alarms",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": true,
"items": "Alarm",
"key": "alarms"
}
]
},
"originalType": "EmbeddedAlarms",
"required": true,
"key": "_embedded"
},
"page": {
"type": "object",
"properties": [
{
"type": "integer",
"name": "size",
"displayName": "size",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "size"
},
{
"type": "integer",
"name": "totalElements",
"displayName": "totalElements",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "totalElements"
},
{
"type": "integer",
"name": "totalPages",
"displayName": "totalPages",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "totalPages"
},
{
"type": "integer",
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "number"
}
],
"name": "page",
"displayName": "page",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "PageDetail",
"displayName": "PageDetail",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "size",
"displayName": "size",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "size"
},
{
"name": "totalElements",
"displayName": "totalElements",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "totalElements"
},
{
"name": "totalPages",
"displayName": "totalPages",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "totalPages"
},
{
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "number"
}
]
},
"originalType": "PageDetail",
"required": true,
"key": "page"
}
}
}AlarmLabels
Properties
TYPE DEFINITION
{
"name": "AlarmLabels",
"type": "object",
"properties": {
"alarm_labels": {
"type": "array",
"items": {
"type": "string"
},
"name": "alarm_labels",
"displayName": "alarm_labels",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "alarm_labels"
}
}
}EventPage
Properties
TYPE DEFINITION
{
"name": "EventPage",
"type": "object",
"properties": {
"_links": {
"type": "object",
"properties": [
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": true,
"key": "self"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "first",
"displayName": "first",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "first"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "last",
"displayName": "last",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "last"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "next",
"displayName": "next",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "next"
},
{
"type": "object",
"properties": [
{
"type": "string",
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "href"
},
{
"type": "boolean",
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "templated"
}
],
"name": "prev",
"displayName": "prev",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "HalLink",
"displayName": "HalLink",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "href",
"displayName": "href",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"string"
],
"required": true,
"key": "href"
},
{
"name": "templated",
"displayName": "templated",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"boolean"
],
"required": false,
"key": "templated"
}
]
},
"originalType": "HalLink",
"required": false,
"key": "prev"
}
],
"name": "_links",
"displayName": "_links",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "PageLinks",
"displayName": "PageLinks",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "self",
"displayName": "self",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": true,
"key": "self"
},
{
"name": "first",
"displayName": "first",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "first"
},
{
"name": "last",
"displayName": "last",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "last"
},
{
"name": "next",
"displayName": "next",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "next"
},
{
"name": "prev",
"displayName": "prev",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"HalLink"
],
"required": false,
"key": "prev"
}
]
},
"originalType": "PageLinks",
"required": true,
"key": "_links"
},
"_embedded": {
"type": "object",
"properties": [
{
"type": "array",
"items": {
"type": "object",
"properties": [],
"name": "Event",
"displayName": "Event",
"typePropertyKind": "TYPE_EXPRESSION",
"rawType": {
"name": "Event",
"displayName": "Event",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
]
},
"additionalProperties": true,
"originalType": "Event"
},
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "events"
}
],
"name": "_embedded",
"displayName": "_embedded",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "EmbeddedEvents",
"displayName": "EmbeddedEvents",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "events",
"displayName": "events",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"array"
],
"required": true,
"items": "Event",
"key": "events"
}
]
},
"originalType": "EmbeddedEvents",
"required": true,
"key": "_embedded"
},
"page": {
"type": "object",
"properties": [
{
"type": "integer",
"name": "size",
"displayName": "size",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "size"
},
{
"type": "integer",
"name": "totalElements",
"displayName": "totalElements",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "totalElements"
},
{
"type": "integer",
"name": "totalPages",
"displayName": "totalPages",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "totalPages"
},
{
"type": "integer",
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "number"
}
],
"name": "page",
"displayName": "page",
"typePropertyKind": "TYPE_EXPRESSION",
"additionalProperties": true,
"rawType": {
"name": "PageDetail",
"displayName": "PageDetail",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"object"
],
"properties": [
{
"name": "size",
"displayName": "size",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "size"
},
{
"name": "totalElements",
"displayName": "totalElements",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "totalElements"
},
{
"name": "totalPages",
"displayName": "totalPages",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "totalPages"
},
{
"name": "number",
"displayName": "number",
"typePropertyKind": "TYPE_EXPRESSION",
"type": [
"integer"
],
"required": true,
"key": "number"
}
]
},
"originalType": "PageDetail",
"required": true,
"key": "page"
}
}
}TokenResponse
Properties
TYPE DEFINITION
{
"name": "TokenResponse",
"type": "object",
"properties": {
"access_token": {
"type": "string",
"name": "access_token",
"displayName": "access_token",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "access_token"
},
"token_type": {
"type": "string",
"name": "token_type",
"displayName": "token_type",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "token_type"
},
"expires_in": {
"type": "integer",
"name": "expires_in",
"displayName": "expires_in",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "expires_in"
},
"scope": {
"type": "string",
"name": "scope",
"displayName": "scope",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "scope"
},
"jti": {
"type": "string",
"name": "jti",
"displayName": "jti",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "jti"
}
}
}ErrorResponse
Properties
TYPE DEFINITION
{
"name": "ErrorResponse",
"type": "object",
"properties": {
"result": {
"type": "string",
"name": "result",
"displayName": "result",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "result"
},
"location": {
"type": "string",
"name": "location",
"displayName": "location",
"typePropertyKind": "TYPE_EXPRESSION",
"required": true,
"key": "location"
},
"error": {
"type": "string",
"name": "error",
"displayName": "error",
"typePropertyKind": "TYPE_EXPRESSION",
"required": false,
"key": "error"
}
}
}/oauth/token
/oauth/token post
POST: /oauth/token (secured)
The AlienVault REST API v2.0 is secured by OAuth 2.0. This is the token endpoint to call to authenticate your client and recieve and OAuth Bearer token to use with all other resource requests. The AlienVault REST API v2.0 only supports the client_credentials grant type.
Possible Responses
200
401
/oauth/token post
CURL EXAMPLE
curl -X POST "https://your-subdomain.alienvault.cloud/api/2.0/oauth/token" \
-d @request_body \
--user username:passwordRESPONSE BODY
200
{
"access_token": "xxx.yyy.zzz",
"token_type": "bearer",
"expires_in": 899,
"scope": "trust read write",
"jti": "3b4cc123-2164-44cb-ae34-9c76d7c429ab"
}Type
object/alarms
/alarms get
GET: /alarms (secured)
Get a page of alarms
Query Parameters
page
The `page` parameter specifies the page number (zero based) of results to return.
| Property | Value |
|---|---|
| required | false |
| type | integer |
| examples | 1 |
size
The `size` parameter specifies the number of results to return for on each page.
| Property | Value |
|---|---|
| required | false |
| type | integer |
| examples | 50 |
sort
The `sort` parameter specifies parameter and direction that the results should be sorted by.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | timestamp_occured,asc |
status
The status of the alarm.
| Property | Value |
|---|---|
| required | false |
| type | array |
| examples | open |
suppressed
A boolean to filter alarms by the suppressed flag.
| Property | Value |
|---|---|
| required | false |
| type | boolean |
| examples | true |
rule_intent
The intent of the rule that triggered the alarm.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | Environmental Awareness |
rule_method
The method of the rule that triggered the alarm.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | AWS EC2 Security Group Modified |
rule_strategy
The strategy of the rule that triggered the alarm.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | Network Access Control Modification |
priority_label
The priority of the alarm.
| Property | Value |
|---|---|
| required | false |
| type | array |
| examples | medium |
alarm_sensor_sources
The uuid of the sensor.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | 308ba880-2518-44bb-9ada-07b158d11713 |
timestamp_occured_gte
Filtered results will include alarms that occurred after this timestamp.
| Property | Value |
|---|---|
| required | false |
| type | number |
| examples | 1517933139670 |
timestamp_occured_lte
Filtered results will include alarms that occurred before this timestamp.
| Property | Value |
|---|---|
| required | false |
| type | number |
| examples | 1517933149670 |
Possible Responses
200
/alarms get
CURL EXAMPLE
curl -X GET "https://your-subdomain.alienvault.cloud/api/2.0/alarms?page=1&size=50&sort=timestamp_occured,asc&status=open&suppressed=true&rule_intent=Environmental Awareness&rule_method=AWS EC2 Security Group Modified&rule_strategy=Network Access Control Modification&priority_label=medium&alarm_sensor_sources=308ba880-2518-44bb-9ada-07b158d11713×tamp_occured_gte=1517933139670×tamp_occured_lte=1517933149670" \
-H "Authorization: Bearer string"RESPONSE BODY
200
{
"_links": {
"first": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=0&size=20&sort=timestamp_occured,desc",
"templated": false
},
"self": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms",
"templated": false
},
"next": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=1&size=20&sort=timestamp_occured,desc",
"templated": false
},
"last": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=175&size=20&sort=timestamp_occured,desc",
"templated": false
}
},
"_embedded": {
"alarms":
"... content omitted for clarity ..."
},
"page": {
"size": 20,
"totalElements": 3506,
"totalPages": 176,
"number": 0
}
}Type
object/{alarmId} get
GET: /alarms/{alarmId} (secured)
Get Alarm Details
URI Parameters
alarmId
| Property | Value |
|---|---|
| required | true |
| type | string |
Possible Responses
200
404
/{alarmId} get
CURL EXAMPLE
curl -X GET "https://your-subdomain.alienvault.cloud/api/2.0/alarms/{alarmId}" \
-H "Authorization: Bearer string"RESPONSE BODY
200
{
"uuid": "971918fd-a569-548a-5a80-1ffcda2a8365",
"has_alarm": false,
"needs_enrichment": true,
"priority": 20,
"suppressed": false,
"events": [
{ "uuid" : "...more content omitted for clarity..."}
],
"rule_intent": "Environmental Awareness",
"app_type": "amazon-aws",
"source_username": "user@alienvault.com",
"security_group_id": "sg-xxxxx",
"destination_name": "ec2.amazonaws.com",
"timestamp_occured": "1517932134000",
"authentication_type": "IAMUser",
"event_type": "Alarm",
"rule_method": "AWS EC2 Security Group Modified",
"priority_label": "low",
"app_id": "amazon-aws",
"source_name": "x.xx.xx.xxxx",
"timestamp_received": "1517933139670",
"rule_strategy": "Network Access Control Modification",
"request_user_agent": "signin.amazonaws.com",
"rule_id": "AWSEC2SecurityGroupMod",
"sensor_uuid": "433152d2-10ee-4645-8c04-9f8269a447e7",
"transient": false,
"event_name": "Add inbound network traffic rule to security group",
"packet_type": "alarm",
"status": "open",
"_links": {
"self": {
"href": "https://mysubdomain.aveng.us/api/2.0/alarms/971918fd-a569-548a-5a80-1ffcda2a8365",
"templated": false
}
}
}
Type
object/labels get
GET: /alarms/{alarmId}/labels (secured)
List label ids for an alarm
URI Parameters
alarmId
| Property | Value |
|---|---|
| required | true |
| type | string |
Possible Responses
200
404
/labels get
CURL EXAMPLE
curl -X GET "https://your-subdomain.alienvault.cloud/api/2.0/alarms/{alarmId}/labels" \
-H "Authorization: Bearer string"RESPONSE BODY
200
{
"alarm_labels": [ "971918fd-a569-548a-5a80-1ffcda2a8365" ]
}Type
object/{labelId} put
PUT: /alarms/{alarmId}/labels/{labelId} (secured)
Add a label to an alarm
URI Parameters
alarmId
| Property | Value |
|---|---|
| required | true |
| type | string |
labelId
| Property | Value |
|---|---|
| required | true |
| type | string |
Possible Responses
200
404
/{labelId} put
CURL EXAMPLE
curl -X PUT "https://your-subdomain.alienvault.cloud/api/2.0/alarms/{alarmId}/labels/{labelId}" \
-H "Authorization: Bearer string" \
-d @request_body/{labelId} delete
DELETE: /alarms/{alarmId}/labels/{labelId} (secured)
Remove a label from an alarm
URI Parameters
alarmId
| Property | Value |
|---|---|
| required | true |
| type | string |
labelId
| Property | Value |
|---|---|
| required | true |
| type | string |
Possible Responses
200
404
/{labelId} delete
CURL EXAMPLE
curl -X DELETE "https://your-subdomain.alienvault.cloud/api/2.0/alarms/{alarmId}/labels/{labelId}" \
-H "Authorization: Bearer string"/events
/events get
GET: /events (secured)
Get a page of events
Query Parameters
page
The `page` parameter specifies the page number (zero based) of results to return.
| Property | Value |
|---|---|
| required | false |
| type | integer |
| examples | 1 |
size
The `size` parameter specifies the number of results to return for on each page.
| Property | Value |
|---|---|
| required | false |
| type | integer |
| examples | 50 |
sort
The `sort` parameter specifies parameter and direction that the results should be sorted by.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | timestamp_occured,asc |
account_name
The account name.
| Property | Value |
|---|---|
| required | true |
| type | string |
| examples | account |
suppressed
A boolean to filter events by the suppressed flag.
| Property | Value |
|---|---|
| required | false |
| type | boolean |
| examples | true |
plugin
The plugin name
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | plugin |
event_name
The name of the event.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | name |
source_name
The source name
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | name |
sensor_uuid
The uuid of the sensor.
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | 308ba880-2518-44bb-9ada-07b158d11713 |
source_username
The username of the person that triggered the event
| Property | Value |
|---|---|
| required | false |
| type | string |
| examples | user@email.com |
timestamp_occured_gte
Filtered results will include events that occurred after this timestamp.
| Property | Value |
|---|---|
| required | false |
| type | number |
| examples | 1517933139670 |
timestamp_occured_lte
Filtered results will include events that occurred before this timestamp.
| Property | Value |
|---|---|
| required | false |
| type | number |
| examples | 1517933149670 |
Possible Responses
200
/events get
CURL EXAMPLE
curl -X GET "https://your-subdomain.alienvault.cloud/api/2.0/events?page=1&size=50&sort=timestamp_occured,asc&account_name=account&suppressed=true&plugin=plugin&event_name=name&source_name=name&sensor_uuid=308ba880-2518-44bb-9ada-07b158d11713&source_username=user@email.com×tamp_occured_gte=1517933139670×tamp_occured_lte=1517933149670" \
-H "Authorization: Bearer string"RESPONSE BODY
200
{
"_links": {
"first": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/events?page=0&size=20&sort=timestamp_occured,desc",
"templated": false
},
"self": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/events",
"templated": false
},
"next": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/events?page=1&size=20&sort=timestamp_occured,desc",
"templated": false
},
"last": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/events?page=175&size=20&sort=timestamp_occured,desc",
"templated": false
}
},
"_embedded": {
"events":
"... content omitted for clarity ..."
},
"page": {
"size": 20,
"totalElements": 3506,
"totalPages": 176,
"number": 0
}
}Type
object/{eventId} get
GET: /events/{eventId} (secured)
Get Event Details
URI Parameters
eventId
| Property | Value |
|---|---|
| required | true |
| type | string |
Possible Responses
200
404
/{eventId} get
CURL EXAMPLE
curl -X GET "https://your-subdomain.alienvault.cloud/api/2.0/events/{eventId}" \
-H "Authorization: Bearer string"RESPONSE BODY
200
{
"uuid": "39a6918f-33f2-ec9b-0fcc-42bb90f10a1f",
"account_name": "generic-account",
"plugin_device_type": "Cloud Infrastructure",
"destination_canonical": "s3.amazonaws.com",
"destination_name": "s3.amazonaws.com",
"has_alarm": false,
"request_user_agent": "s3.amazonaws.com",
"packet_type": "log",
"source_canonical": "s3.amazonaws.com",
"event_name": "PutObject",
"timestamp_occured": "1528817037000",
"source_service_name": "s3.amazonaws.com",
"event_type": "AwsApiCall",
"app_name": "amazon-aws",
"timestamp_received": "1528817107938",
"destination_hostname": "s3.amazonaws.com",
"source_infrastructure_name": "Amazon Global",
"plugin": "Amazon AWS CloudTrail",
"app_type": "amazon-aws",
"authentication_type": "AWSService",
"access_control_outcome": "Allow",
"suppressed": "false",
"plugin_device": "CloudTrail",
"destination_infrastructure_type": "Cloud Service",
"source_infrastructure_type": "Cloud Service",
"destination_zone": "us-east-1",
"needs_enrichment": true,
"source_hostname": "s3.amazonaws.com",
"app_id": "amazon-aws",
"plugin_family": "Amazon",
"plugin_version": "0.24",
"destination_userid": "101720206348",
"event_action": "Create",
"destination_infrastructure_name": "Amazon Global",
"source_name": "s3.amazonaws.com",
"received_from": "s3.amazonaws.com",
"event_description": "Action for uploading an object (PUT or POST).",
"_links": {
"self": {
"href": "https://mysubdomain.aveng.us/api/2.0/events/39a6918f-33f2-ec9b-0fcc-42bb90f10a1f",
"templated": false
}
}
}
Type
object