API Documentation

REST API for automation and integration

📖

Overview

All API endpoints accept both form-encoded data (application/x-www-form-urlencoded) and JSON (application/json). Responses are always JSON.

Base URL:

🌐 Network Tools

POST /api/ping

ICMP ping test (4 packets)

Parameters

hoststringHostname or IP address

Example

curl -X POST constellation/api/ping \
  -H "Content-Type: application/json" \
  -d '{"host": "google.com"}'
POST /api/dns

DNS record lookup

Parameters

hoststringDomain name
typestringRecord type: A, AAAA, MX, TXT, NS, CNAME, PTR

Example

curl -X POST constellation/api/dns \
  -H "Content-Type: application/json" \
  -d '{"host": "github.com", "type": "A"}'
POST /api/portscan

TCP port scanner with banner grabbing

Parameters

hoststringHostname or IP address
portsstringOptional. Ports to scan (e.g., "22,80,443" or "8000-8100")

Example

curl -X POST constellation/api/portscan \
  -H "Content-Type: application/json" \
  -d '{"host": "scanme.nmap.org", "ports": "22,80,443"}'
POST /api/whois

WHOIS domain/IP registration lookup

Parameters

hoststringDomain name or IP address

Example

curl -X POST constellation/api/whois \
  -H "Content-Type: application/json" \
  -d '{"host": "example.com"}'
POST /api/ssl-check

SSL/TLS certificate information and expiration

Parameters

hoststringHostname (optionally with port, e.g., "example.com:8443")

Example

curl -X POST constellation/api/ssl-check \
  -H "Content-Type: application/json" \
  -d '{"host": "github.com"}'
POST /api/traceroute

Network path tracing (max 20 hops)

Parameters

hoststringHostname or IP address

Example

curl -X POST constellation/api/traceroute \
  -H "Content-Type: application/json" \
  -d '{"host": "google.com"}'
POST /api/mac-lookup

MAC address vendor lookup

Parameters

macstringMAC address (any format: XX:XX:XX:XX:XX:XX)

Example

curl -X POST constellation/api/mac-lookup \
  -H "Content-Type: application/json" \
  -d '{"mac": "00:1A:2B:3C:4D:5E"}'
POST /api/http-headers

Fetch HTTP response headers for a URL

Parameters

urlstringURL to fetch (https:// prefix added if missing)

Example

curl -X POST constellation/api/http-headers \
  -H "Content-Type: application/json" \
  -d '{"url": "https://github.com"}'
POST /api/tcp-test

Test TCP connection to host:port

Parameters

hoststringHostname or IP
portstringPort number

Example

curl -X POST constellation/api/tcp-test \
  -H "Content-Type: application/json" \
  -d '{"host": "google.com", "port": "443"}'
POST /api/reverse-dns

Reverse DNS lookup (PTR record)

Parameters

ipstringIP address

Example

curl -X POST constellation/api/reverse-dns \
  -H "Content-Type: application/json" \
  -d '{"ip": "8.8.8.8"}'
GET /api/public-ip

Get the server's public IP address

Example

curl constellation/api/public-ip

🔧 Utilities

POST /api/password

Generate a random password

Parameters

lengthintPassword length (8-64, default: 16)
uppercaseboolInclude uppercase letters
lowercaseboolInclude lowercase letters
numbersboolInclude numbers
symbolsboolInclude symbols

Example

curl -X POST constellation/api/password \
  -H "Content-Type: application/json" \
  -d '{"length": 20, "uppercase": true, "lowercase": true, "numbers": true, "symbols": true}'
POST /api/hash

Calculate hash of text

Parameters

textstringText to hash
algorithmstringmd5, sha1, sha256, sha512

Example

curl -X POST constellation/api/hash \
  -H "Content-Type: application/json" \
  -d '{"text": "hello world", "algorithm": "sha256"}'
POST /api/base64

Base64 encode/decode

Parameters

textstringText to encode/decode
actionstring"encode" or "decode"

Example

curl -X POST constellation/api/base64 \
  -H "Content-Type: application/json" \
  -d '{"text": "hello world", "action": "encode"}'

⚡ Speed Test

GET /api/speedtest/ping

Latency test endpoint (returns server timestamp)

Example

curl constellation/api/speedtest/ping
GET /api/speedtest/download

Download test data (for bandwidth measurement)

Parameters

sizeintSize in MB (1-100, default: 10)

Example

curl -o /dev/null constellation/api/speedtest/download?size=5
POST /api/speedtest/upload

Upload test (measures upload speed)

Example

dd if=/dev/zero bs=1M count=5 | curl -X POST constellation/api/speedtest/upload --data-binary @-