Core concepts
API scopes
Choose the minimum Management API permissions for an integration.
Scopes limit the operations a Management API key can perform. A key must also have access to the target server.
| Scope | Allows |
|---|---|
accounts:read |
List accounts, read account details, inspect commands, read server configuration, and export history. |
accounts:create |
Create one account or bulk-create accounts. |
accounts:update |
Update, enable, disable, archive, delete, or reset passwords for accounts. Also update server configuration. |
finance:deposit |
Deposit funds into a trading account. |
finance:withdraw |
Withdraw funds from a trading account. |
metrics:read |
Read metric snapshots and subscribe to live account metrics. |
credits:read |
Read the organization’s API credit balance. |
webhooks:manage |
Reserved for webhook management. No public Management API endpoint currently uses this scope. |
Server access
Section titled “Server access”Every key has one of two server access modes:
allallows the key to act on every server owned by the organization.selectedallows the key to act only on server IDs chosen when the key is created.
A correct scope does not override a server restriction. Koneth returns 403 if the key cannot access the requested server.
Recommended key profiles
Section titled “Recommended key profiles”| Integration | Suggested scopes |
|---|---|
| Read-only reporting | accounts:read, metrics:read, credits:read |
| Client onboarding | accounts:read, accounts:create |
| Account operations | accounts:read, accounts:update |
| Funding service | accounts:read, finance:deposit, finance:withdraw |