Page tree

Versions Compared

Key

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

...

Note

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

...

Sample request

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

...

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 idString (GUID)Requiredeeb7823e-8e23-462e-a39a-0648ad4c639e
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 byStringOptionallogTimeStamp
sortDirection0=Ascending, 1=DescendingIntegerOptional1
pageSizeNumber of log entries per pageIntegerOptional10
pageIndexPage index to return log entries fromIntegerOptional1

Excerpt Include
Ampersand for parameters
Ampersand for parameters
nopaneltrue

...

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

...


...