Skip to main content
POST
/
api
/
check
Check API Key
curl --request POST \
  --url https://octanist.com/api/check \
  --header 'X-API-KEY: <api-key>'
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.octanist.com/llms.txt

Use this file to discover all available pages before exploring further.

Validate your API key to ensure it’s working correctly. This is useful for testing your integration and troubleshooting authentication issues.

​
Usage

This endpoint requires no request body - just include your API key in the X-API-KEY header. 
curl -X POST "https://octanist.com/api/check" \
  -H "X-API-KEY: your_api_key_here"

​
Response

​
Success

If your API key is valid: 
{
  "success": true
}

​
Error

If your API key is invalid or missing: 
{
  "error": "Invalid or missing API key"
}

​
Common Use Cases

  • Integration Testing: Verify your API key before making other API calls
  • Health Checks: Include in monitoring to ensure your API access is working
  • Troubleshooting: Quick way to test if authentication issues are API key related
  • Setup Validation: Confirm API key configuration in new environments

Authorizations

​
X-API-KEY
string
header
required

API key for authentication

Response

API key is valid

​
success
boolean
Example:

true