API keys are account-scoped credentials. Create and manage them through the
authenticated gHypurr account interface; key management is not a public API.
Requirements
- An active Pro or Elite entitlement
- Current API Terms and other required account consent
- Authentication within the previous 15 minutes
- At least one selected scope
Create a key
- Open API keys.
- Enter a descriptive name such as
Production client.
- Select only the scopes the client needs.
- Optionally add trusted IPv4, IPv6, or CIDR entries.
- Select Create API key.
- Copy the secret immediately and store it in a secret manager.
The secret is shown once. gHypurr retains a non-reversible verification value
and a visible prefix, not a recoverable copy of the secret.
Scopes
Optional IP allowlist
An empty allowlist permits requests from any source IP. A non-empty allowlist
accepts exact IPv4/IPv6 addresses or CIDR ranges and rejects requests whose
source cannot be verified against a rule. Up to 20 rules can be attached to a
key.
Examples:
Rotate or revoke
- Rotate revokes the old secret and displays a replacement once. Update the
client before removing the old value from your secret manager.
- Revoke disables the key immediately. Revoke any key that may have been
exposed or is no longer used.
Do not place API keys in browser client bundles, mobile application source,
query strings, logs, or Git repositories. Use a server-side secret store or
local environment variable.
