Skip to main content
GET
/
api
/
v2
/
api-key
/
validate
Validate API key
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
  }
}

Authorizations

api_key
string
header
required

Response

API key is valid

_metadata
object
required
status
enum<string>
required

Status of the API key validation

Available options:
ok
Example:

"ok"

valid
boolean
required

Whether the API key is valid

Example:

true

credits
object
required

Credit usage information for the API key

I