Custom device logs API v1 - GET logs

deprecated

This API is deprecated.

  • For Log monitoring - Custom devices, Hosts, or Process Groups, what to use instead depends on which version of Log Monitoring you use:
  • For Calculated metrics - Log Monitoring, use the Settings API endpoint with schemaId builtin:logmonitoring.schemaless-log-metric.

Lists all the available logs on the specified custom device.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/infrastructure/custom-devices/{customDeviceId}/logs

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
customDeviceIdstring

The Dynatrace entity ID of the required custom device.

pathrequired

Response

The result is a JSON, containing 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 codes

CodeTypeDescription
200LogListForCustomDeviceResult

Success

400ErrorEnvelope

Failed. See the response body for details

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The LogListForCustomDeviceResult object

Logs available on the Custom Device.

ElementTypeDescription
logsLogForCustomDevice[]

The list of available logs.

The LogForCustomDevice object

The list of available logs.

ElementTypeDescription
availableForAnalysisboolean

The log is available (true) or not available (false) for analysis.

pathstring

The full path to the log.

Response body JSON model

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