List server runtime events

GET

/api/v1/management/servers/{serverId}/runtime/events

curl --request GET \
  --url 'https://api.koneth.com/api/v1/management/servers/6be9a699-2f28-402e-b64e-93ba6bdafe1b/runtime/events?cursor=0&limit=100' \
  --header 'Authorization: <Authorization>' \
  --header 'X-Request-Id: onboarding-client-1042'

• Production
• Local development

Returns the runtime event feed Koneth Main stores for one server, oldest first after cursor. Requires accounts:read. Events are written when the server reports them, so a quiet server returns an empty page, and login events are also projected into the login monitor log. Keep the returned cursor and pass it back to resume without re-reading events.

Authorizations

• managementKey

Parameters

Path Parameters

serverId

required

string format: uuid

UUID of a trading server owned by your organization.

Example

6be9a699-2f28-402e-b64e-93ba6bdafe1b

Header Parameters

X-Request-Id

string

Optional correlation ID used for API request billing and logs.

Example

onboarding-client-1042

Query Parameters

cursor

integer

0

Return events recorded after this cursor.

limit

integer

default: 100 >= 1 <= 1000

Maximum number of events to return.

Responses

200

Runtime events returned in ascending cursor order.

Media typeapplication/json

object

events

required

Array<object>

object

cursor

required

Monotonic cursor within one server’s feed. Pass it back to resume.

string

eventId

required

string format: uuid

aggregateType

required

What the event is about.

string

Allowed values: account server

aggregateId

required

Identifier of the account or server the event belongs to.

string

accountNumber

required

Trading account number, or null for server-level events.

string

nullable

type

required

Event name, such as LOGIN_SUCCEEDED or POSITION_CLOSED.

string

payload

required

Event-specific fields reported by the server.

object

key

additional properties

any

occurredAt

required

When the server says the event happened.

string format: date-time

receivedAt

required

When Koneth Main stored the event.

string format: date-time

cursor

required

Cursor of the last returned event, or the requested cursor when the page is empty.

string

hasMore

required

Whether another page is immediately available.

boolean

Example

{
  "events": [
    {
      "cursor": "4812",
      "aggregateType": "account",
      "type": "LOGIN_SUCCEEDED"
    }
  ],
  "cursor": "4812"
}

400

Invalid request.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example^generated

{
  "error": "example",
  "issues": [
    {}
  ]
}

401

Management API authentication is missing or invalid.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Management API authentication required"
}

402

The organization cannot cover the active API request price.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Insufficient API credits"
}

403

The key lacks the required scope or server access.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Missing API scope: accounts:read"
}

500

Unexpected server error.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Internal server error"
}