Skip to content
API status
API reference

Get server configuration

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

Returns the target trading server’s configuration. Requires accounts:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
serverId
required
string format: uuid

UUID of a trading server owned by your organization.

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

Header Parameters

Section titled “Header Parameters”
X-Request-Id
string

Optional correlation ID used for API request billing and logs.

Example
onboarding-client-1042

Responses

Section titled “Responses”

200

Section titled “200”

Server configuration returned.

Media typeapplication/json
object
server
required
object
serverId
required
string
serverName
required
string
companyName
required
string
currency
required
string
Allowed values: USD EUR GBP NGN ZAR KES GHS CAD AUD JPY CHF AED
currencySymbol
required
string
environment
required
string
Allowed values: demo real
maxLeverage
required

The ceiling. Any whole number up to it is allowed. Null removes it entirely, which is also what permits unlimited accounts.

integer
nullable >= 1
supportedLeverage

Retained for clients that predate the ceiling; it echoes the maximum as a single value.

Array<integer>
>= 1 items
unlimitedMarginCallPercent

For accounts with no margin requirement: the share of balance at which they are warned. Percentages, not margin level.

number
unlimitedStopOutPercent

For accounts with no margin requirement: the share of balance at which open positions are closed. Zero closes the moment equity reaches zero.

number
defaultLeverage
required
One of:
integer
>= 1
status
required
string
Allowed values: active disabled
Example
{
  "server": {
    "currency": "USD",
    "environment": "demo",
    "status": "active"
  }
}

400

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

401

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}