Skip to content
Revox
Get started
API Reference
Auth Status

Retrieve

auth_status.retrieve() -> AuthStatusRetrieveResponse { authenticated }
GET/auth-status

Check if your API key is still valid.

ReturnsExpand Collapse
class AuthStatusRetrieveResponse { authenticated }
authenticated: bool

True if the API key is still valid.

Retrieve

require "revox"

revox = Revox::Client.new(api_key: "My API Key")

auth_status = revox.auth_status.retrieve

puts(auth_status)
{
  "authenticated": true
}
Returns Examples
{
  "authenticated": true
}