Host logs API v1 - POST analysis job

Starts the log analysis job.

Optionally, you can indicate a start and end time stamp or query to filter log content.

The request produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{hostId}/logs/{logPath}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts/{hostId}/logs/{logPath}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{hostId}/logs/{logPath}

Authentication

To execute this request, you need the Read logs (LogExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

All special characters in the log path must be escaped.

Parameter Type Description In Required
hostId string

The Dynatrace entity ID of the required host.

path required
logPath string

The full pathname of the log.

path required
query string

Narrows down the scope of the analysis to the entries, matching the specified criteria.

The criteria must use the text pattern query syntax.

query optional
startTimestamp integer

The start timestamp of the analysis range, in UTC milliseconds.

If not set, then 2 hours behind from current timestamp is used.

query optional
endTimestamp integer

The end timestamp of the analysis range, in UTC milliseconds.

If not set, then the current timestamp is used.

query optional
body ExtractFields

Extract fields from the log content to form custom columns.

See Search patterns in log data and parse results in Dynatrace Documentation for the syntax definition and examples.

The special characters must be escaped.

body optional

Body format

The ExtractFields object

A query to extract log content to a custom column.

Element Type Description Required
parsingMode string

The parsing mode for log analysis entries presentation. Possible values are: json, disabled, and all.

optional
customParsingPatterns string

The query for content extraction.

See Search patterns in log data and parse results in Dynatrace Documentation for the syntax definition and examples.

optional

Response

Response codes

Code Description
202

Success. The response body contains the ID of the job.

400

Failed. See the response body for details.

404

Not found. See the response body for details.

Response body

A successful request doesn't return any content.

Example

In this example the request starts a log analysis job for the Windows Application Log from the HOST-EA474F61FFBD5C97 host. The timeframe of analysis lies between time stamps 1537840000000 and 1537880000000.

The API token is passed in the Authorization header.

The response contains the ID of the started analysis job.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logs/Windows%20Application%20Log?startTimestamp=1537840000000&endTimestamp=1537880000000 \
  -H 'Authorization: Api-Token abcdefjhij1234567890' \

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logs/Windows%20Application%20Log?startTimestamp=1537840000000&endTimestamp=1537880000000

Response content

{
  "jobId": "32502e45-ed3d-47b9-b150-23e787ee285e"
}

Response code

202