Appliance Monitoring API

Device Monitoring Appliance Controller

List Stats (single statistics category, single appliance)

get/stats/{appliance}/{statistics}

List statistics from a single statistics category for a single appliance. Statistics of the health and network categories are presented in reverse chronological order.

Request

Security:

Trend Micro Cloud One API Key

path Parameters

appliance required	integer <int64> DSM-assigned unique identifier of appliance. Example: 2
statistics required	string Statistics category to retrieve. Enum: "health" "cpu" "network" "rule" Example: health

query Parameters

maxItems	integer <int32> Default: 1 Number of individual statistics to return for each category. If omitted, returns single most recent statistic for each category. maxItems parameter must be <= 2000 Example: maxItems=5
start	integer <int64> Specify timestamp when statistics were taken, in milliseconds from UNIX epoch. Statistic returned will be after this time. If omitted, assumes no lower bound. Example: start=1556220110157
stop	integer <int64> Specify upper bound timestamp for returned statistics, in milliseconds from UNIX epoch. If omitted, assumes current time. Example: stop=1556220146676

header Parameters

api-version

required

string

API Version

Value: "v1"

Responses

200

Successful operation.

400

The request was malformed and could not be processed.

404

No records exist for at least one of the requested appliance(s).

416

limit parameter must be <= 2000

503

device-monitoring service is not yet initialized

Response samples

application/json

{"healthStats": [{"timestamp": 0,
"state": "normal",
"reason": "string"
}
],
"cpuStats": [{"timestamp": 0,
"cpus": [{"core": "string",
"utilization": 0
}
]
}
],
"reputationStats": [{"timestamp": 0,
"statTable": "string",
"section": "string",
"name": "string",
"value": 0,
"comment": "string"
}
],
"networkStats": [{"timestamp": 0,
"connectionRate": 0,
"packetsDroppedNic": 0,
"packetsTotalNic": 0,
"packetsDroppedFpga": 0,
"packetsTotalFpga": 0,
"packetsDroppedEngineF": 0,
"packetsTotalEngineF": 0,
"packetsDroppedEngineK": 0,
"packetsTotalEngineK": 0,
"packetsDroppedEngineL": 0,
"packetsTotalEngineL": 0,
"interfaceStats": [{"name": "string",
"rxPackets": 0,
"rxBytes": 0,
"rxPacketsDropped": 0,
"txPackets": 0,
"txBytes": 0,
"txPacketsDropped": 0
}
]
}
],
"ruleStats": [{"timestamp": 0,
"filterId": "string",
"triggeredFlows": 0,
"matchedFlows": 0
}
]
}

List Stats (single appliance)

get/stats/{appliance}

List statistics for a single appliance. Statistics of the health and network categories are presented in reverse chronological order.

Request

Security:

Trend Micro Cloud One API Key

path Parameters

appliance

required

integer <int64>

DSM-assigned unique identifier of appliance.

Example: 2

query Parameters

maxItems	integer <int32> Default: 1 Number of individual statistics to return for each category. If omitted, returns single most recent statistic for each category. maxItems parameter must be <= 2000 Example: maxItems=5
start	integer <int64> Specify timestamp when statistics were taken, in milliseconds from UNIX epoch. Statistic returned will be after this time. If omitted, assumes no lower bound. Example: start=1556220110157
statistics	Array of strings List of statistics categories to retrieve. If omitted, returns data on: cpu, health, and network Items Enum: "health" "cpu" "network" "rule"
stop	integer <int64> Specify upper bound timestamp for returned statistics, in milliseconds from UNIX epoch. If omitted, assumes current time. Example: stop=1556220146676

header Parameters

api-version

required

string

API Version

Value: "v1"

Responses

200

Successful operation.

400

The request was malformed and could not be processed.

404

No records exist for at least one of the requested appliance(s).

416

limit parameter must be <= 2000

503

device-monitoring service is not yet initialized

Response samples

application/json

{"healthStats": [{"timestamp": 0,
"state": "normal",
"reason": "string"
}
],
"cpuStats": [{"timestamp": 0,
"cpus": [{"core": "string",
"utilization": 0
}
]
}
],
"reputationStats": [{"timestamp": 0,
"statTable": "string",
"section": "string",
"name": "string",
"value": 0,
"comment": "string"
}
],
"networkStats": [{"timestamp": 0,
"connectionRate": 0,
"packetsDroppedNic": 0,
"packetsTotalNic": 0,
"packetsDroppedFpga": 0,
"packetsTotalFpga": 0,
"packetsDroppedEngineF": 0,
"packetsTotalEngineF": 0,
"packetsDroppedEngineK": 0,
"packetsTotalEngineK": 0,
"packetsDroppedEngineL": 0,
"packetsTotalEngineL": 0,
"interfaceStats": [{"name": "string",
"rxPackets": 0,
"rxBytes": 0,
"rxPacketsDropped": 0,
"txPackets": 0,
"txBytes": 0,
"txPacketsDropped": 0
}
]
}
],
"ruleStats": [{"timestamp": 0,
"filterId": "string",
"triggeredFlows": 0,
"matchedFlows": 0
}
]
}

List Network Stats For Appliance

get/stats/appliancenetworkstatistics

List Network statistics for a single appliance. The network category statistics are presented in reverse chronological order.

Request

Security:

Trend Micro Cloud One API Key

query Parameters

appliance required	integer <int64> DSM-assigned unique identifier of appliance. Example: appliance=1
cursor	string Default: "" 'next' string from previous request. Used to get next page of data.
includeTotal	boolean Default: true Whether to include totalCount, if set to true include totalCount, if set to false totalCount is not calculated or included. If omitted, assumes to include totalCount. This is an expensive calculation that may slow down the API for you. If you don't need this field, we suggest you set this to False Example: includeTotal=true
limit	integer <int32> Default: 10 Number of individual statistics to return. If omitted, returns the 10 most recent statistics. limit parameter must be <= 2000 Example: limit=5
start	integer <int64> Specify timestamp when statistics were taken, in milliseconds from UNIX epoch. Statistic returned will be after this time. If omitted, assumes no lower bound. Example: start=1556220110157
stop	integer <int64> Specify upper bound timestamp for returned statistics, in milliseconds from UNIX epoch. If omitted, assumes current time. Example: stop=1556220146676

header Parameters

api-version

required

string

API Version

Value: "v1"

Responses

200

Successful operation.

400

The request was malformed and could not be processed.

404

No records exist for at least one of the requested appliance(s).

416

limit parameter must be <= 2000

503

device-monitoring service is not yet initialized

Response samples

application/json

{"totalCount": 0,
"appliance": 0,
"next": "string",
"networkstatistics": [{"timestamp": 0,
"connectionRate": 0,
"packetsDroppedNic": 0,
"packetsTotalNic": 0,
"packetsDroppedFpga": 0,
"packetsTotalFpga": 0,
"packetsDroppedEngineF": 0,
"packetsTotalEngineF": 0,
"packetsDroppedEngineK": 0,
"packetsTotalEngineK": 0,
"packetsDroppedEngineL": 0,
"packetsTotalEngineL": 0,
"interfaceStats": [{"name": "string",
"rxPackets": 0,
"rxBytes": 0,
"rxPacketsDropped": 0,
"txPackets": 0,
"txBytes": 0,
"txPacketsDropped": 0
}
]
}
]
}

List Health Stats For Appliance

get/stats/appliancehealthstatistics

List health statistics for a single appliance. The health category statistics are presented in reverse chronological order.

Request

Security:

Trend Micro Cloud One API Key

query Parameters

appliance required	integer <int64> DSM-assigned unique identifier of appliance. Example: appliance=1
cursor	string Default: "" 'next' string from previous request. Used to get next page of data.
includeTotal	boolean Default: true Whether to include totalCount, if set to true include totalCount, if set to false totalCount is not calculated or included. If omitted, assumes to include totalCount. This is an expensive calculation that may slow down the API for you. If you don't need this field, we suggest you set this to False Example: includeTotal=true
limit	integer <int32> Default: 10 Number of individual statistics to return. If omitted, returns the 10 most recent statistics. limit parameter must be <= 2000 Example: limit=5
start	integer <int64> Specify timestamp when statistics were taken, in milliseconds from UNIX epoch. Statistic returned will be after this time. If omitted, assumes no lower bound. Example: start=1556220110157
stop	integer <int64> Specify upper bound timestamp for returned statistics, in milliseconds from UNIX epoch. If omitted, assumes current time. Example: stop=1556220146676

header Parameters

api-version

required

string

API Version

Value: "v1"

Responses

200

Successful operation.

400

The request was malformed and could not be processed.

404

No records exist for at least one of the requested appliance(s).

416

limit parameter must be <= 2000

503

device-monitoring service is not yet initialized

Response samples

application/json

{"totalCount": 0,
"appliance": 0,
"next": "string",
"healthstatistics": [{"timestamp": 0,
"state": "normal",
"reason": "string"
}
]
}

List CPU Stats For Appliance

get/stats/appliancecpustatistics

List CPU statistics for a single appliance.

Request

Security:

Trend Micro Cloud One API Key

query Parameters

appliance required	integer <int64> DSM-assigned unique identifier of appliance. Example: appliance=1
cursor	string Default: "" 'next' string from previous request. Used to get next page of data.
includeTotal	boolean Default: true Whether to include totalCount, if set to true include totalCount, if set to false totalCount is not calculated or included. If omitted, assumes to include totalCount. This is an expensive calculation that may slow down the API for you. If you don't need this field, we suggest you set this to False Example: includeTotal=true
limit	integer <int32> Default: 10 Number of individual statistics to return. If omitted, returns the 10 most recent statistics. limit parameter must be <= 2000 Example: limit=5
start	integer <int64> Specify timestamp when statistics were taken, in milliseconds from UNIX epoch. Statistic returned will be after this time. If omitted, assumes no lower bound. Example: start=1556220110157
stop	integer <int64> Specify upper bound timestamp for returned statistics, in milliseconds from UNIX epoch. If omitted, assumes current time. Example: stop=1556220146676

header Parameters

api-version

required

string

API Version

Value: "v1"

Responses

200

Successful operation.

400

The request was malformed and could not be processed.

404

No records exist for at least one of the requested appliance(s).

416

limit parameter must be <= 2000

503

device-monitoring service is not yet initialized

Response samples

application/json

{"totalCount": 0,
"appliance": 0,
"next": "string",
"cpustatistics": [{"timestamp": 0,
"cpus": [{"core": "string",
"utilization": 0
}
]
}
]
}

List Stats (multi-appliance)

get/stats

List multiple statistics categories for multiple appliances. Statistics of the health and network categories are presented in reverse chronological order.

Request

Security:

Trend Micro Cloud One API Key

query Parameters

appliances	Array of integers <int64> List of appliance IDs to retrieve statistics for. Invalid appliances and appliances without statistics are excluded from 'appliances' in the returned json. If omitted, returns data on all available appliances.
cursor	string Default: "" 'next' string from previous request. Used to get next page of data.
includeTotal	boolean Default: true Whether to include totalCount, if set to true include totalCount, if set to false totalCount is not calculated or included. If omitted, assumes to include totalCount. This is an expensive calculation that may slow down the API for you. If you don't need this field, we suggest you set this to False Example: includeTotal=true
maxItems	integer <int32> Default: 1 Number of individual statistics to return for each category. If omitted, returns single most recent statistic for each category. maxItems parameter must be <= 2000 Example: maxItems=5
start	integer <int64> Specify timestamp when statistics were taken, in milliseconds from UNIX epoch. Statistic returned will be after this time. If omitted, assumes no lower bound. Example: start=1556220110157
statistics	Array of strings List of statistics categories to retrieve. If omitted, returns data on: cpu, health, and network Items Enum: "health" "cpu" "network" "rule" Example: statistics=health
stop	integer <int64> Specify upper bound timestamp for returned statistics, in milliseconds from UNIX epoch. If omitted, assumes current time. Example: stop=1556220146676

header Parameters

api-version

required

string

API Version

Value: "v1"

Responses

200

Successful operation.

400

The request was malformed and could not be processed.

416

limit parameter must be <= 2000

503

device-monitoring service is not yet initialized

Response samples

application/json

{"totalCount": 0,
"count": 0,
"next": "string",
"appliances": [{"appliance": 1,
"statistics": {"healthStats": [{"timestamp": 0,
"state": "normal",
"reason": "string"
}
],
"cpuStats": [{"timestamp": 0,
"cpus": [{"core": null,
"utilization": null
}
]
}
],
"reputationStats": [{"timestamp": 0,
"statTable": "string",
"section": "string",
"name": "string",
"value": 0,
"comment": "string"
}
],
"networkStats": [{"timestamp": 0,
"connectionRate": 0,
"packetsDroppedNic": 0,
"packetsTotalNic": 0,
"packetsDroppedFpga": 0,
"packetsTotalFpga": 0,
"packetsDroppedEngineF": 0,
"packetsTotalEngineF": 0,
"packetsDroppedEngineK": 0,
"packetsTotalEngineK": 0,
"packetsDroppedEngineL": 0,
"packetsTotalEngineL": 0,
"interfaceStats": [{"name": null,
"rxPackets": null,
"rxBytes": null,
"rxPacketsDropped": null,
"txPackets": null,
"txBytes": null,
"txPacketsDropped": null
}
]
}
],
"ruleStats": [{"timestamp": 0,
"filterId": "string",
"triggeredFlows": 0,
"matchedFlows": 0
}
]
}
}
]
}

➔ Next to Cross Account Permissions Template API