Skip to main content
API v1 is deprecated. It continues to work but will be removed in a future release. Migrate to v2 to access the full endpoint set, improved authentication, profile management, and invoice operations.

​
What Changed

API v2 introduces a versioned URL structure, new endpoint groups, and an optional Bearer token authentication flow alongside the existing API key method.
Areav1v2
Base path/customer/v1//customer/v2/
Auth — API keyX-ORBIT-KEY: <key> headerSame — unchanged
Auth — Bearer tokenNot supportedAuthorization: Bearer <token>
License endpoints/customer/v1/licenses/.../customer/v2/licenses/...
IP whitelistingFlat endpointsNested under /licenses/{id}/ips
API key managementNot available/customer/v2/api-keys/...
ProfileNot available/customer/v2/profile/...
InvoicesNot available/customer/v2/invoices/...

​
Authentication — No Change Required

If you authenticate with the X-ORBIT-KEY header, no change is needed for auth. The same key works with v2. 
# Works with both v1 and v2
curl -H "X-ORBIT-KEY: YOUR_API_KEY" https://api.orbitflare.com/customer/v2/licenses
Optionally, you can upgrade to Bearer token auth (device flow or wallet signature) for improved security. See the Auth endpoints for details.

​
Endpoint Mapping

​
Licenses

v1 Endpointv2 Equivalent
GET /customer/v1/licensesGET /customer/v2/licenses
GET /customer/v1/licenses/{id}GET /customer/v2/licenses/{id}
POST /customer/v1/licenses/{id}/reset-keyPOST /customer/v2/licenses/{id}/reset-key
POST /customer/v1/licenses/{id}/regenerate-keyPOST /customer/v2/licenses/{id}/regenerate-key
GET /customer/v1/locationsGET /customer/v2/licenses/locations
GET /customer/v1/licenses/{id}/ipsGET /customer/v2/licenses/{id}/ips
POST /customer/v1/licenses/{id}/ipsPOST /customer/v2/licenses/{id}/ips
DELETE /customer/v1/licenses/{id}/ips/{ip}DELETE /customer/v2/licenses/{id}/ips/{ip}

​
New in v2 Only

These endpoints do not exist in v1 and are available exclusively in v2:
EndpointDescription
POST /customer/v2/auth/device/codeInitiate device authorization flow
POST /customer/v2/auth/device/tokenExchange device code for access token
POST /customer/v2/auth/wallet/challengeRequest wallet signature challenge
POST /customer/v2/auth/wallet/verifyVerify wallet signature and get token
GET /customer/v2/api-keysList all API keys
POST /customer/v2/api-keysCreate a new API key
PATCH /customer/v2/api-keys/{id}Update an API key
DELETE /customer/v2/api-keys/{id}Delete an API key
GET /customer/v2/profileGet user profile
PATCH /customer/v2/profileUpdate user profile
GET /customer/v2/profile/balanceGet account balance
GET /customer/v2/invoicesList invoices
GET /customer/v2/invoices/{id}Get a specific invoice
POST /customer/v2/invoices/{id}/payPay invoice with account balance

​
Migration Steps

1

Update your base URL

Change the path prefix in your client from /customer/v1/ to /customer/v2/:
# Before
curl -H "X-ORBIT-KEY: YOUR_API_KEY" \
  https://api.orbitflare.com/customer/v1/licenses

# After
curl -H "X-ORBIT-KEY: YOUR_API_KEY" \
  https://api.orbitflare.com/customer/v2/licenses
2

Update the locations endpoint

The locations endpoint moved from a top-level path into the licenses group:
# Before
GET /customer/v1/locations

# After
GET /customer/v2/licenses/locations
3

Test your integration

Run your existing integration against the v2 endpoints. The response shapes for shared endpoints (licenses, IPs) are backward compatible. No response parsing changes should be required for migrated endpoints.
4

(Optional) Upgrade authentication

If you want to use Bearer token auth instead of API keys, implement the device authorization flow or wallet signature flow.

​
Need Help?

If you encounter issues during migration, reach out on Discord or contact support@orbitflare.com.