Skip to content
API status
API reference

Sync a server runtime

POST
/api/v1/management/servers/{serverId}/runtime/sync
curl --request POST \
--url https://api.koneth.com/api/v1/management/servers/6be9a699-2f28-402e-b64e-93ba6bdafe1b/runtime/sync \
--header 'Authorization: <Authorization>' \
--header 'X-Request-Id: onboarding-client-1042'

Asks the server to poll Koneth Main now and returns the server’s own report for that poll. Requires accounts:read. Use this when a scheduled job needs queued commands and market configuration applied immediately instead of waiting for the server’s next poll. The call waits for the server, so it can take up to two minutes. Koneth returns 400 when the server does not answer or rejects the poll.

serverId
required
string format: uuid

UUID of a trading server owned by your organization.

Example
6be9a699-2f28-402e-b64e-93ba6bdafe1b
X-Request-Id
string

Optional correlation ID used for API request billing and logs.

Example
onboarding-client-1042

The server completed a poll.

Media typeapplication/json

The server’s poll report, including queued commands and market configuration status.

object
key
additional properties
any
Examplegenerated
{}

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
Examplegenerated
{
"error": "example",
"issues": [
{}
]
}

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"
}

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"
}

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"
}

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"
}