cURL
curl --request GET \ --url https://app.octavehq.com/api/v2/api-key/validate \ --header 'api_key: <api-key>'
{ "_metadata": { "usage": 0, "requestId": "requestId", "message": "message", "timestamp": "2021-01-01T00:00:00.000Z" }, "status": "ok", "valid": true, "credits": { "totalUsed": 175, "totalRemaining": 425, "totalMax": 575, "quotaUsed": 150, "quotaAvailable": 350, "quotaMax": 500, "period": "month", "creditsUsed": 25, "creditsAvailable": 75 } }
This endpoint validates the API key provided in the header. If the request succeeds, the API key is valid. Rate limited to 1000 requests per minute.
API key is valid
Show child attributes
Status of the API key validation
ok
"ok"
Whether the API key is valid
true
Credit usage information for the API key