API 키

oxb API 키 만들기와 사용: 서버당 하나, 액세스·시크릿 키, 분당 120회 요청, 오류 코드.

이 페이지는 아직 사용자의 언어로 번역되지 않았습니다. 영어 버전을 표시합니다.

The oxb API lets you read and control your server from your own tools: a Discord bot, your website, a panel of your own. Every API Key belongs to one license and only returns the data of that server.

API Keys screen with a key bound to a server — API Keys: one per server.

Create a key#

1
Open Panel → API Keys
Press Create API Key, give it a name and choose the server it belongs to.
2
Save the secret key
It is shown only once. Copy the access key and the secret key in a safe place.
3
Use it in your requests
They are sent in two headers: x-api-key (access) and x-api-secret (secret).

Check that the credentials work

curl -X POST https://api.oxbservices.com/v1/auth/verify \
  -H "x-api-key: YOUR_ACCESS_KEY" \
  -H "x-api-secret: YOUR_SECRET_KEY"

Response

{
  "valid": true,
  "key": { "id": "…", "name": "My bot", "status": "ACTIVE", "totalRequests": 12 },
  "server": { "id": "…", "name": "My server", "licenseExpiresAt": "2027-02-01T00:00:00.000Z" },
  "rateLimit": { "limit": 120, "window": "1m" }
}

Rules#

One key per server. To create another, delete the previous one.
The key works while the license of the server is valid (neither expired nor banned).
Limit: 120 requests per minute per key. Every response includes X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.
Never put an API Key in a client resource or in a public repository.

Errors#

Status	`code`	Meaning
401	`MISSING_CREDENTIALS`	`x-api-key` or `x-api-secret` is missing.
401	`INVALID_KEY` / `INVALID_SECRET`	The access key or the secret is not correct.
403	`KEY_INACTIVE` / `KEY_EXPIRED`	The key is suspended, cancelled or expired.
403	`NO_LINKED_LICENSE` / `LICENSE_NOT_FOUND`	The key is not bound to a server, or the server no longer exists.
403	`LICENSE_BANNED` / `LICENSE_EXPIRED`	The license of the server is banned or expired: renew it to keep using the API.
429	`RATE_LIMIT_EXCEEDED`	You went over 120 per minute. `retryAfter` gives the seconds to wait.
400	`MISSING_PARAM` / `INVALID_BODY`	A required field of the body is missing.
503	`SERVER_OFFLINE`	Actions that need the server (kick, ban, commands): the server is off or not answering.

마지막 업데이트: 2026년 11월 11일