Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Get Log Entries API retrieves a list of entries for a virtual machine. 


Sample request

GET https://api.armor.com/log-management/vms/{CoreInstanceId}/entries?searchText=&filterEventType=&filterSize=&sortField=logTimeStamp&sortDirection=1&pageSize=10&pageIndex=1

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type

/log-management/vms/{CoreInstanceId}/entries?searchText=&filterEventType=&filterSize=&sortField=logTimeStamp&sortDirection=1&pageSize=10&pageIndex=1 

GET

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
CoreInstanceIDGUID for agent CORE instance idStringRequired
searchTextText to search for in OS logsStringOptional
filterEventTypeFilter by Linux or Windows OS logsStringOptional
filterSizeFilter by log size greater than value in bytesIntegerOptional
sortFieldField to sort byStringOptional
sortDirection0=Ascending, 1=DescendingIntegerOptional
pageSizeNumber of log entries per pageIntegerOptional
pageIndexPage index to return log entries fromIntegerOptional

Sample return

StatusResponse
200
{
   "total": 15418,
   "vmLogList": [
       {
           "eventType": "wineventlog",
           "logTimeStamp": "2015-11-23T00:13:02Z",
           "size": 5624,
           "message": "<<raw log message>>"
       }
   ]
}
404
CoreInstanceId not found for account

Output

The following table describes the expected results for specific outputs that may not be clear enough within the sample output.

ReturnTypeDescriptionPossible valuesExample