Chaves de API

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.

Create a key#

1. 1

   Open Panel → API Keys

   Press Create API Key, give it a name and choose the server it belongs to.

2. 2

   Save the secret key

   It is shown only once. Copy the access key and the secret key in a safe place.

3. 3

   Use it in your requests

   They are sent in two headers: x-api-key (access) and x-api-secret (secret).

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

{
  "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#