Host Log Monitoring API - GET log content

Gets the content of the specified log.

The log content can be retrieved using this call only when logAnalysisStatus equals READY in the job status call.

The request produces an application/json payload.

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

Parameters

Parameter Type Description In Required
hostId string

The entity ID of the required host.

 path required
jobId string

The ID of the required log analysis job.

You can retrieve it from the response of the POST /entity/infrastructure/hosts/{hostId}/logs/{logPath} request.

 path required
scrollToken string

The scrollToken value from the previous response.

You can use it to get the next page of results. Without it the first page is always returned.

 query optional
pageSize integer

The number of records per result page.

If not set then each page contains 100 results.

Maximum allowed value is 10000.

 query optional

Response format

When scrolling through the result records using scroll token, the last result page contains an empty records list node and no scrollToken node.

The LogJobRecordsResult object

The results of the log analysis job.

Element Type Description
records LogRecord[]

The list of log analysis results.

The last page contains empty list.
scrollToken string

The scroll token for the next page of results.

Without it you'll get the first page again.

The LogRecord object

The analysis result for a single log entry.

Element Type Description
timestamp integer

The timestamp of the log entry, in UTC milliseconds.
logLevel string

The severity level of the log entry.
hostId string

The entity ID of the host that produced the log.

Not applicable to OS logs.
text string

The text of the log entry.
customFields object

The map of the log entry custom fields.

Example

In this example the request lists the content of the OS log from the HOST-FE05D86A03025CAA host, which has been processed by the job with ID 32502e45-ed3d-47b9-b150-23e787ee285e.

The API token is passed in the Authorization header.

The response contains OS logs of this host. The result is truncated to three entries.

Curl

curl -X GET \
  https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logs/jobs/32502e45-ed3d-47b9-b150-23e787ee285e/records \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logs/jobs/32502e45-ed3d-47b9-b150-23e787ee285e/records

Response content

{
  "records": [
    {
      "timestamp": 1537954219052,
      "logLevel": "INFO",
      "text": "2018/09/26 09:30:19 UTC\tInformation\tClassic\t\t11707\t\tSYSTEM\tInfo\tProduct: DESK Updater -- Installation completed successfully.",
      "customFields": {}
    },
    {
      "timestamp": 1537954219052,
      "logLevel": "INFO",
      "text": "2018/09/26 09:30:19 UTC\tInformation\tClassic\t\t1033\t\tSYSTEM\tInfo\tWindows Installer installed the product. Product Name: DESK Updater. Product Version: 1.156.0. Product Language: 1033. Manufacturer: DESK. Installation success or error status: 0.",
      "customFields": {}
    },
    {
      "timestamp": 1537954219052,
      "logLevel": "INFO",
      "text": "2018/09/26 09:30:19 UTC\tInformation\tClassic\t\t11707\t\tSYSTEM\tInfo\tProduct: DESK Updater -- Installation completed successfully.",
      "customFields": {}
    }
  ]
}

Response code

200