API Overview

CloakProbe provides a simple REST API to retrieve IP information in multiple formats.

Base URL

https://ip.cloakprobe.dev

Or your own deployment URL.

No authentication required. CloakProbe is designed to be publicly accessible.

CloakProbe itself has no rate limiting. If you’re running behind Cloudflare, you can configure rate limiting there.

All endpoints include permissive CORS headers, allowing browser-based requests from any origin.

CloakProbe detects your IP address from these headers (in order):

curl https://ip.cloakprobe.dev/api/v1/info

curl https://ip.cloakprobe.dev/api/v1/plain

curl https://ip.cloakprobe.dev/healthz
# {"status":"ok"}

# Get just your IP
MY_IP=$(curl -s https://ip.cloakprobe.dev/api/v1/plain | head -1 | cut -d' ' -f2)
echo "My IP: $MY_IP"

CloakProbe returns standard HTTP status codes:

Status	Meaning
`200`	Success
`500`	Internal server error

Errors are returned as JSON:

{
  "error": "Description of the error"
}