Host logs API v1 - GET logs
Lists all the available OS logs on the specified host.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{hostId}/logs |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/hosts/{hostId}/logs | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/hosts/{hostId}/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
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| hostId | string | The Dynatrace entity ID of the required host. | path | required |
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
truewhen the stored log is ready for analysis.
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Log | Success |
| 400 | ErrorEnvelope | Failed. See the response body for details |
Response body objects
The LogList4hostResult object
OS logs available on the host.
| Element | Type | Description |
|---|---|---|
| contentAccess | boolean | The access to the log content is granted ( |
| logs | Log4host[] | The list of available OS logs. |
The Log4host object
The list of available OS logs.
| Element | Type | Description |
|---|---|---|
| availableForAnalysis | boolean | The log is available ( |
| path | string | The full path to the log. |
| size | integer | The size of the log, bytes. |
Response body JSON model
{
"contentAccess": true,
"logs": [
{
"availableForAnalysis": true,
"path": "string",
"size": 1
}
]
}Example
In this example the request lists the OS logs from the HOST-FE05D86A03025CAA host.
The API token is passed in the Authorization header.
The response contains OS logs of this host.
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logs \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/hosts/HOST-FE05D86A03025CAA/logsResponse content
{
"contentAccess": true,
"logs": [
{
"path": "Windows Application Log",
"size": 20975616,
"availableForAnalysis": true
},
{
"path": "Windows System Log",
"size": 16846848,
"availableForAnalysis": true
},
{
"path": "Windows Security Log",
"size": 20975616,
"availableForAnalysis": true
}
]
}Response code
200