Loading
GGX_LABS
DEVELOPER API / AUTHENTICATION

Authentication and API keys

Create, use, manage, and revoke API keys through the GGX Labs Developer Console.

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.8

Key lifecycle

OperationEndpointPurpose
CreatePOST /v1/keysCreate a new API key.
ListGET /v1/keysList keys belonging to the authenticated account.
RevokePOST /v1/keys/{id}/revokeDisable 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

HTTPCodeMeaning
401API_KEY_REQUIREDBearer API key is missing.
401INVALID_API_KEYKey is invalid or revoked.
403INSUFFICIENT_SCOPEValid key lacks the endpoint's required scope.