Logs

Search logs

Changed on

Searches system logs with various filter parameters. If no time range is specified, defaults to the last 24 hours.

get/api/logs

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/logs
  • Auth: none required

Query parameters

startstring required

Represents an instant in time as an ISO 8601 string.

Example:2023-10-31T12:34:56.789Z

ISO 8601 start of the time range (e.g. 2024-01-01T00:00:00.000Z). Defaults to 24 hours ago.

endstring required

Represents an instant in time as an ISO 8601 string.

Example:2023-10-31T12:34:56.789Z

ISO 8601 end of the time range (e.g. 2024-01-02T00:00:00.000Z). Defaults to now.

levelsstring required

Comma-separated list of log levels to include (e.g. error,warn). Valid values: silent, error, warn, info, debug, trace.

scopeIdsstring required

Comma-separated list of scope IDs to filter by (e.g. connector123,connector456).

scopeTypesstring required

Comma-separated list of scope types to filter by (e.g. south,north). Valid values: south, north, history-query, internal.

itemIdsstring required

Comma-separated list of item IDs to filter by (e.g. item123,item456).

groupIdsstring required

Comma-separated list of group IDs to filter by (e.g. group123,group456).

messageContentstring required

Substring to search for within log messages.

pagenumber double

Response

Paginated list of log entries

totalElementsnumber double required

The total number of elements across all pages.

sizenumber double required

The size of the page, i.e., the maximum number of elements per page.

numbernumber double required

The number of the current page, starting at 0.

totalPagesnumber double required

The total number of pages (which can be 0 if there are no elements).

Example response

{
  "content": [
    {
      "timestamp": "2023-10-31T12:34:56.789Z",
      "scopeId": "connector123",
      "scopeName": "South Connector 1",
      "itemId": "item123",
      "itemName": "Temperature sensor",
      "groupId": "group123",
      "groupName": "Temperature sensors",
      "message": "Connection failed to host: timeout after 5s"
    }
  ],
  "totalElements": 2,
  "size": 10,
  "totalPages": 1
}

Changes

  • 87f398dc0b57Revision changes
    • breaking

      added the new required query request parameter groupIds

    • breaking

      added the new required query request parameter itemIds

    • info

      removed the web-server enum value from the // response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • ea1c80cb9c69Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter groupIds

    • warning

      deleted the query request parameter itemIds

    • warning

      added the new web-server enum value to the // response property for the response status