Cluster Journal

Returns a paginated list of cluster journal entries (events and messages from cluster operations).

Request

Property	Value
Method	`GET`
URL	`/api/cluster/journal`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/cluster/journal" \
  -H "Authorization: Bearer YOUR_TOKEN"

Query Parameters

Parameter	Type	Required	Default	Description
`page`	integer	No	1	Page number
`rowsPerPage`	integer	No	20	Number of items per page
`orderBy`	string	No	-	Field name to sort by
`order`	string	"asc" \| "desc"	-	Sort order

With query parameters

bash

curl -X GET "{BASE_URL}/api/cluster/journal?page=value&rowsPerPage=value&orderBy=value" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Code	Description
200	Success
401	Unauthorized - Invalid or missing token
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Pagination

Parameter	Type	Description
`data.totalItems`	integer	Total number of journal entries
`data.itemsPerPage`	integer	Number of items per page
`data.totalPages`	integer	Total number of pages
`data.currentPage`	integer	Current page number
`data.hasPrevious`	boolean	Indicates if a previous page exists
`data.hasNext`	boolean	Indicates if a next page exists
`data.lastTimestamp`	integer	Timestamp of the most recent entry (Unix timestamp in ms)

Journal Entry Object

Parameter	Type	Description
`data.list[].id`	integer	Unique identifier of the journal entry
`data.list[].objectName`	string	Name of the object/service that generated the entry
`data.list[].message`	string	Journal message
`data.list[].threadName`	string	Name of the thread that generated the entry
`data.list[].createDate`	integer	Entry creation timestamp (Unix timestamp in ms)

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "totalItems": 4,
    "itemsPerPage": 20,
    "totalPages": 1,
    "currentPage": 1,
    "hasPrevious": false,
    "hasNext": false,
    "lastTimestamp": 1767011493554,
    "list": [
      {
        "id": 3,
        "objectName": "ClusterStreamService",
        "message": "New Cluster Connection: 127.0.0.1",
        "threadName": "WorkerPool-thread-004",
        "createDate": 1767011493554
      },
      {
        "id": 2,
        "objectName": "ClusterStreamService",
        "message": "New Cluster Connection: 127.0.0.1",
        "threadName": "WorkerPool-thread-005",
        "createDate": 1767011493553
      },
      {
        "id": 1,
        "objectName": "ClusterStreamService",
        "message": "New Cluster Connection: 127.0.0.1",
        "threadName": "WorkerPool-thread-006",
        "createDate": 1767011493553
      },
      {
        "id": 0,
        "objectName": "ClusterStreamService",
        "message": "Cluster Stream Server has been started!",
        "threadName": "main",
        "createDate": 1767011488014
      }
    ]
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1767345695261
  }
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.