Retrieve task logs

GET /log/{env_org}?{query_parameters}

Overview

This API retrieves the Task log information for the specified Environment/Org.

Prerequisites

Read access to the requested assets

Request

 GET https://{controlplane_path}/api/1/rest/public/log/{env_org}?{query_parameters}

Path Parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic control plane. Example: `control-plane-name.snaplogic.com` Where `control-plane-name` is the control plane you are using. For example, elastic uat emea
`org`	Required. The name of the SnapLogic Environment/Org.

Query Parameters


Key	Type	Description
`ruuid`	string	Required. Returns log information about the task with the specified runtime ID.
`log_level`	string	Returns log information at the specified level of detail. Valid values: `error` – Returns only error logs. `warn` – Returns both warning logs and error logs. `info` – Returns all logged information, including warning logs and error logs. Default: `info`
`limit`	integer	Returns no more than the specified number of results. You can use `limit` and `offset` for pagination. Valid values: 1 through 100,000 Default: 100

Request Header

Specify Basic for authorization and application/json for content type.

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

None.

Response

Response Body

 {
  "response_map": {
    "extra": { ... },
    "total": ...,
    "entries": [
      {
        "_source": {
          "msg": "...",
          "lvl": "...",
          "ts": "...",
          "prc": "...",
          "fi": "..."
        }
      },
      ...
      {
        "_source": {
          "xid": "...",
          "snrd": "...",
          "prc": "...",
          "linid": "...",
          "ts": "...",
          "plrd": "...",
          "fi": "...",
          "msg": "...",
          "lvl": "...",
          "snlb": "...",
          "exc": "..."
        }
      }
    ]
  },
  "http_status_code": 200
}


Key	Type	Description
`extra`	object
`total`	integer	The number of log entries returned.
`entries`	array	An array of objects containing metadata about each log entry. `msg`. The message in the log. `lvl`. The type of the log entry. Possible values: `INFO` `WARN` `ERROR` `ts`. The timestamp of the entry. Format: UTC `prc`. The process that was logged. `fi`. The line in the code that generated the log entry. If `lvl` is `ERROR`: `xid`. The transaction ID. `snrd`. The Snap runtime ID. `linid`. `plrd`. The Pipeline runtime ID. `snlb`. The Snap label or name. `exc`. Any exception that occurred.