On this page
Create a key
The Developer Console creates API keys for the authenticated account. The backend accepts a name, requested scopes, and a requested rate limit, then caps the effective rate at the account entitlement.
POST https://backend.ggxlabs.in/v1/keys Content-Type: application/json { "name": "Production", "scopes": ["ip:read"], "rateLimitPerMinute": 60 }Secret handling
The Developer Console states that the secret is shown once at creation. Store it in a server-side secret manager and do not expose it to browsers or public repositories.
Authenticate requests
API tool endpoints use the HTTP Bearer scheme.
Authorization: Bearer <API_KEY> GET https://backend.ggxlabs.in/v1/ip/8.8.8.8Key lifecycle
| Operation | Endpoint | Purpose |
|---|---|---|
| Create | POST /v1/keys | Create a new API key. |
| List | GET /v1/keys | List keys belonging to the authenticated account. |
| Revoke | POST /v1/keys/{id}/revoke | Disable an existing key. |
The backend hashes API keys for authentication and retains key metadata such as prefix, scopes, status, and rate limit. Revoked keys are rejected by the authentication middleware.
Authentication errors
| HTTP | Code | Meaning |
|---|---|---|
| 401 | API_KEY_REQUIRED | Bearer API key is missing. |
| 401 | INVALID_API_KEY | Key is invalid or revoked. |
| 403 | INSUFFICIENT_SCOPE | Valid key lacks the endpoint's required scope. |
