API introduction

The RiftIP API is a REST API over HTTPS that speaks JSON. It manages your account — sub-users, allowlists, IPs and usage. Proxy traffic itself goes through the gateway, not the API.

#Base URL

https://api.riftip.com/v1

#A first request

curl https://api.riftip.com/v1/account \
  -H "Authorization: Bearer $RIFTIP_API_KEY"

const res = await fetch("https://api.riftip.com/v1/account", {
  headers: { Authorization: `Bearer ${process.env.RIFTIP_API_KEY}` },
});
console.log(await res.json());

import os, requests

r = requests.get(
    "https://api.riftip.com/v1/account",
    headers={"Authorization": f"Bearer {os.environ['RIFTIP_API_KEY']}"},
)
print(r.json())

#Conventions

• Request and response bodies are JSON; send Content-Type: application/json with a body.
• Timestamps are ISO 8601 in UTC, e.g. 2026-10-20T09:30:00Z.
• Byte counts are integers; bandwidth in usage reports is in bytes.
• IDs are prefixed strings, e.g. su_8f2k1d for a sub-user.
• List endpoints are paginated — see Errors & pagination.

#Versioning

The version is part of the path (/v1). Within a version we only add fields and endpoints; anything that would break an integration ships as a new version, with at least 12 months' overlap.