Process group log monitoring API - GET logs

Lists all the available OS logs on the specified process group.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{pgId}/logs SaaS https://{your-environment-id}.live.dexp.ae/api/v1/entity/infrastructure/process-groups/{pgId}/logs

Authentication

To execute this request, you need the Access logs permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
pgId	string	The entity ID of the process group.	path	required

Response format

The result is JSON-formatted data that contains 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 parameters JSON model

The LogList4pgResult object

The list of available process group logs.

Element	Type	Description
logs	LogFile4pg[]	The list of available process group logs.

The LogFile4pg object

Element	Type	Description
path	string	The full path to the log.
size	integer	The size of the log, bytes
hosts	Host4pg[]	The distribution of the process group log across hosts.

The Host4pg object

The process group log on the host.

Element	Type	Description
hostId	string	The entity ID of the host.
logSize	integer	The size of the PG log for the host, bytes.
contentAccess	boolean	The access to the log content is granted (true) or denied (false).
availableForAnalysis	boolean	The log is available (true) or not available (false) for analysis.

    
{
  "logs": [
    {
      "path": "string",
      "size": 0,
      "hosts": [
        {
          "hostId": "string",
          "logSize": 0,
          "contentAccess": true,
          "availableForAnalysis": true
        }
      ]
    }
  ]
}

Example

In this example the request lists the logs for the PROCESS_GROUP-54A8B0B75D36E463 process group.

The API token is passed in the Authorization header.

The response contains logs of this process group.

Curl

curl -X GET \
  https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-E0E2BD1773B29C26/logs \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-54A8B0B75D36E463/logs

Response content

{
  "logs": [
    {
      "path":"c:\\Users\\labuser\\.DESK\\easyTravel 2.0.0\\easyTravel\\log\\BusinessBackend_#-#.log",
      "size":15798199,
      "hosts": [
        {
          "hostId":"HOST-D4EC0D8F510A6F60",
          "logSize":10,
          "contentAccess":true,
          "availableForAnalysis":true
        },
        {
          "hostId":"HOST-B66B773D12C49189",
          "logSize":15798189,
          "contentAccess":true,
          "availableForAnalysis":true
        }
      ]
    },
    {
      "path":"c:\\Users\\labuser\\.DESK\\easyTravel 2.0.0\\easyTravel\\log\\BusinessBackend.log",
      "size":17532565,
      "hosts": [
        {
          "hostId":"HOST-D4EC0D8F510A6F60",
          "logSize":17532565,
          "contentAccess":true,
          "availableForAnalysis":true
        }
      ]
    }
  ]
}

Response code

200