Host Log Monitoring API - GET logs

Lists all the available OS logs on the specified host.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{hostId}/logs SaaS https://{your-environment-id}.live.dexp.ae/api/v1/entity/infrastructure/hosts/{hostId}/logs

Authentication

To execute this request, you need the Access logs permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
hostId	string	The entity ID of the required host.	path	required

Response format

The result is a JSON, containing contains the array of objects, each representing a log.

For the default environment, the availableForAnalysis attribute is always set to true.
For upgraded Log Monitoring environments, the availableForAnalysis attribute is set to true when the stored log is ready for analysis.

Response parameters JSON model

The LogList4hostResult object

OS logs available on the host.

Element	Type	Description
contentAccess	boolean	The access to the log content is granted (`true`) or denied (`false`).
logs	Log4host[]	The list of available OS logs.

The Log4host object

The list of available OS logs.

Element	Type	Description
path	string	The full path to the log.
size	integer	The size of the log, bytes.
availableForAnalysis	boolean	The log is available (`true`) or not available (`false`) for analysis.

    
{
  "contentAccess": true,
  "logs": [
    {
      "path": "string",
      "size": 0,
      "availableForAnalysis": true
    }
  ]
}

Example

In this example the request lists the OS logs from the HOST-FE05D86A03025CAA host.

The API token is passed in the Authorization header.

The response contains OS logs of this host.

Curl

curl -X GET \
  https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logs \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logs

Response content

{
  "contentAccess": true,
  "logs": [
    {
      "path": "Windows Application Log",
      "size": 20975616,
      "availableForAnalysis": true
    },
    {
      "path": "Windows System Log",
      "size": 16846848,
      "availableForAnalysis": true
    },
    {
      "path": "Windows Security Log",
      "size": 20975616,
      "availableForAnalysis": true
    }
  ]
}

Response code

200