Custom device logs API v1 - POST analysis job

Starts the log analysis job.

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

The request produces an application/json payload.

POST	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs/{logPath}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs/{logPath}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs/{logPath}`

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.

All special characters in the log path must be escaped.

Parameter	Type	Description	In	Required
customDeviceId	string	The Dynatrace entity ID of the required custom device.	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

A query to extract log content to a custom column.

Element Type Description Required

parsingMode

string

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

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

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{
  "parsingMode": "json",
  "customParsingPatterns": "\"user %{STRING:User} logged\", \"job took %{INTEGER:Time} ms\""
}

Code	Type	Description
202		Success. The response body contains the ID of the job.
400	ErrorEnvelope	Failed. See the response body for details.
404	ErrorEnvelope	Not found. See the response body for details.