Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Note

You can use the Get Packages Status API to find the coreInstance ID.

...

Sample request

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

...

Excerpt Include
API table parts (snippet)
API table parts (snippet)
nopaneltrue

API Call / URLMethod / Type

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

GET


Excerpt Include
Parameters to include (snippet)
Parameters to include (snippet)
nopaneltrue

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
Code Block
languagetext
{
   "total": 15418,
   "vmLogList": [
       {
           "eventType": "wineventlog",
           "logTimeStamp": "2015-11-23T00:13:02Z",
           "size": 5624,
           "message": "<<raw log message>>"
       }
   ]
}
404
Code Block
languagetext
CoreInstanceId not found for account


...

Output

Excerpt Include
Output results (snippet)
Output results (snippet)
nopaneltrue

ReturnTypeDescriptionPossible valuesExample