API access — SiteViewly

Your API key

For security, we only store a one-way hash of your key - never the key itself. That means we can only show it to you once, right when it's generated. If you lose it, regenerate a new one (this replaces the old key).

Checking...

Documentation

Base URL: https://api.siteviewly.com

Authentication: send your API key as a Bearer token on every request:

Authorization: Bearer sv_your_api_key_here

POST /api/v1/links

Create a new preview link.

curl -X POST https://api.siteviewly.com/api/v1/links \
  -H "Authorization: Bearer sv_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "targetDomain": "example.com",
    "targetIp": "203.0.113.10",
    "ttlMinutes": 1440,
    "linkPassword": "optional-password"
  }'

Leave ttlMinutes out entirely for a link that never expires. Leave linkPassword out for no password.

{
  "slug": "examplecom",
  "url": "https://examplecom.preview.siteviewly.com",
  "expiresAt": 1783900000000
}

GET /api/v1/links

List all of your active preview links.

curl https://api.siteviewly.com/api/v1/links \
  -H "Authorization: Bearer sv_your_api_key_here"

{
  "links": [
    {
      "slug": "examplecom",
      "target_domain": "example.com",
      "target_ip": "203.0.113.10",
      "target_port": 80,
      "target_protocol": "http",
      "created_at": "2026-07-10T09:00:00.000Z",
      "expires_at": "2026-07-11T09:00:00.000Z",
      "password_protected": false,
      "hit_count": 3
    }
  ]
}

GET /api/v1/links/:slug

Get details for a single link you own.

curl https://api.siteviewly.com/api/v1/links/examplecom \
  -H "Authorization: Bearer sv_your_api_key_here"

{ "link": { "slug": "examplecom", "...": "same fields as above" } }

DELETE /api/v1/links/:slug

Delete one of your links immediately.

curl -X DELETE https://api.siteviewly.com/api/v1/links/examplecom \
  -H "Authorization: Bearer sv_your_api_key_here"

{ "ok": true, "deleted": "examplecom" }

GET /api/v1/account

Check your account status and plan limits. Never returns your password.

curl https://api.siteviewly.com/api/v1/account \
  -H "Authorization: Bearer sv_your_api_key_here"

{
  "account": {
    "email": "[email protected]",
    "name": "Your Name",
    "plan": "business",
    "plan_name": "Business",
    "email_verified": true,
    "active_links": 4,
    "max_active_links": 100,
    "allow_custom_ttl": true,
    "has_password_protection": true
  }
}