Sync server license capacity

POST

/api/v1/management/servers/{serverId}/capacity/sync

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

• Production
• Local development

Re-points the server’s license at the newest active product in its product family and returns the resulting account cap. Requires accounts:create. Call this after Koneth publishes a new version of the product a server is licensed under, when the server should adopt its new account cap without being reconnected. Returns 404 when no active product matches the license.

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

Responses

200

License capacity refreshed.

Media typeapplication/json

object

activeAccountCap

required

Maximum number of active accounts the license now allows.

integer

productId

required

Identifier of the product the license now points at.

string format: uuid

Example

{
  "activeAccountCap": 100
}

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

404

The requested resource was not found.

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": [
    {}
  ]
}

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