• Home
  • Dynatrace API
  • Environment
  • Log Monitoring v1
  • Hosts
  • GET log content

Host logs API v1 - 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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{hostId}/logs/jobs/{jobId}/records
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts/{hostId}/logs/jobs/{jobId}/records
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{hostId}/logs/jobs/{jobId}/records

Authentication

To execute this request, you need an access token with LogExport scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
hostIdstring

The Dynatrace entity ID of the required host.

pathrequired
jobIdstring

The ID of the required log analysis job.

You can retrieve it from the response of the POST analysis job request.

pathrequired
scrollTokenstring

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.

queryoptional
pageSizeinteger

The number of records per result page.

If not set, each page contains 100 results.

Maximum allowed value is 10000.

queryoptional

Response

When scrolling through the result records using a scroll token, the last result page contains an empty records array and no scrollToken field.

Response codes

CodeTypeDescription
200LogJobRecordsResult

Success

400ErrorEnvelope

Failed. See the response body for details

Response body objects

The LogJobRecordsResult object

The results of the log analysis job.

ElementTypeDescription
recordsLogRecord[]

The list of log analysis results.

The last page contains empty list.

scrollTokenstring

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.

ElementTypeDescription
timestampinteger

The timestamp of the log entry, in UTC milliseconds.

logLevelstring

The severity level of the log entry.

hostIdstring

The entity ID of the host that produced the log.

Not applicable to OS logs.

textstring

The text of the log entry.

customFieldsobject

The map of the log entry custom fields.

Response body JSON model

json
{ "records": [ { "timestamp": 1, "logLevel": "string", "hostId": "string", "text": "string", "customFields": {} } ], "scrollToken": "string" }

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

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

Request URL

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

Response content

json
{ "records": [ { "timestamp": 1537954219052, "logLevel": "INFO", "text": "2018/09/26 09:30:19 UTC\tInformation\tClassic\t\t11707\t\tSYSTEM\tInfo\tProduct: Dynatrace 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: Dynatrace Updater. Product Version: 1.156.0. Product Language: 1033. Manufacturer: Dynatrace. 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: Dynatrace Updater -- Installation completed successfully.", "customFields": {} } ] }

Response code

200

Related topics
  • Log Monitoring Classic

    Learn how to enable Log Monitoring, the insights that Log Monitoring can provide, and more.