Page tree

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

Compare with Current View Page History

Version 1 Next »




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
1 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



Overview

Error rendering macro 'excerpt-include'

No link could be created for 'Anywhere and Complete Users Specific API (snippet)'.

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

Error rendering macro 'excerpt-include'

No link could be created for 'API table parts (snippet)'.

API Call / URLMethod / Type

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

GET

Error rendering macro 'excerpt-include'

No link could be created for 'Parameters to include (snippet)'.

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

Error rendering macro 'excerpt-include'

No link could be created for 'Output results (snippet)'.

ReturnTypeDescriptionPossible valuesExample