Check an API key

GET/auth-status

Check that your API key is valid, e.g. before storing it: a 200 with authenticated true means it is; any other answer means the key was not accepted.

Request

curl -X GET "https://www.getrevox.com/api/auth-status" \
  -H "Authorization: Bearer $REVOX_API_KEY"

const res = await fetch("https://www.getrevox.com/api/auth-status", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.REVOX_API_KEY}`,
  },
});
const data = await res.json();
console.log(data);

import os

import requests

response = requests.get(
    "https://www.getrevox.com/api/auth-status",
    headers={"Authorization": f"Bearer {os.environ['REVOX_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

Try itSend this request live

Response

Success

{ "authenticated": true }

{ "error": "Unauthorized, invalid API key" }

Request body

No body: send the request without one.

Response

200

authenticatedboolean
True if the API key is still valid.

Errors

401Missing or invalid API key{ "error": string }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.