Test Endpoint
Simple endpoint for testing API connectivity and authentication
Parameters
This endpoint doesn't take any parameters.
Request
Send your key in the X-API-Key header. More languages and patterns live on the
code examples page.
curl -s "https://apixies.io/api/v1/test" \ -H "X-API-Key: YOUR_API_KEY"
Response
The result sits under data in the standard envelope. See the
response format guide for errors and status codes.
returns
- data.authenticated
- True when your key or sandbox token was accepted.
- data.sandbox
- True when the call ran on a sandbox token.
- data.timestamp
- Server time of the call in ISO 8601.
- data.message
- A short note that the connection works.
{
"status": "success",
"http_code": 200,
"code": "SUCCESS",
"message": "API test successful",
"data": {
"message": "API connection successful",
"authenticated": true,
"timestamp": "2025-05-15T12:34:56+00:00",
"sandbox": false
}
}
Authentication and limits
This endpoint needs an API key. Use the sandbox ("try it" above) to test it without registering. See the authentication guide for details.
Standard rate limits apply to this endpoint.
Common use cases
API key verification
Verify that your API key is correctly configured and working before integrating other endpoints into your application.
Network connectivity testing
Use as a simple connectivity test from your server to the Apixies API. Verify firewall rules, proxy settings, and DNS resolution.
Integration test baseline
Include the test endpoint in your integration test suite as a baseline. If this endpoint fails, the issue is connectivity, not your code.
More documentation
Get a free API key
A temporary key takes one click and no signup. Register and you get 75 requests/day. Free tier is for development & small projects.