Returns authenticated key metadata

GET 
/auth/me

Returns the verified identity of the request coming in via HTTP Basic Auth. A smoke-test endpoint — to quickly verify the integration works.

RETURNED FIELDS (NO api_secret_hash or similar sensitive field):

• api_key_id: Internal numeric ID
• reseller_id: WHMCS tblclients.id (the reseller's customer id)
• name: Key label
• permissions: Scope list (["orders:create", "*"])
• client_ip: The client IP that made this request (resolved via X-Forwarded-For with a trusted proxy resolver)
• last_used_at: The last time this key was used (RFC 3339)
• expires_at: The key's expiry date (NULL = never)
• rate_limit_rpm: Per-key override (NULL = default 60)
• auto_apply_credit: POST /orders automatic balance charge toggle (true = default; if false the order returns pending_payment + notice=auto_apply_credit_disabled, and the reseller pays the invoice manually). Changed via the admin CLI: php bin/api-key-update.php <id> --auto-apply-credit=0|1

Responses

200

Authenticated, identity returned

Response Headers

X-RateLimit-Limit

The per-minute limit defined for this key

X-RateLimit-Remaining

Number of requests remaining in the current window

X-RateLimit-Reset

Unix epoch of the start of the next window (UTC seconds)

401

Authentication failed — missing header, invalid API key/secret, revoked or expired key.

Response Headers

WWW-Authenticate

RFC 7235 header — signals the Basic Auth requirement to the client

403

IP whitelist violation — the incoming IP is not in the key's allow list

429

Per-minute limit exceeded

Response Headers

Retry-After

Seconds to wait before retrying after a 429 (RFC 7231 §7.1.3)

X-RateLimit-Limit

The per-minute limit defined for this key

X-RateLimit-Remaining
X-RateLimit-Reset

Unix epoch of the start of the next window (UTC seconds)