Hosting integration
Organisation model, API keys and customer onboarding.
What you can automate
The Lumin API creates and updates routes, provides DNS instructions, runs domain verification, manages available profiles and IP lists, and reads usage and monitoring.
The API is served over HTTPS on the panel origin under /v1. Accepted changes enter Lumin's synchronisation mechanism. A successful write confirms configuration acceptance, not completion of every network operation.
Organisation and customer isolation
Choose an integration model before onboarding:
- One hosting organisation - manage routes through your own panel. Your backend must enforce which customer can change each route. A Lumin key has admin access to the whole organisation.
- Separate customer organisations - separate permissions and limits. Each organisation needs its own key or an authorised user session.
Organisation keys cannot create organisations, change subscriptions or access /v1/admin/*. Creating an organisation requires a user account and respects that account's limit. Agree the partnership model and limits before automating onboarding.
Suggested onboarding sequence
- Choose an organisation and store its ID in your integration configuration.
- Create and store an API key on your hosting backend.
- Fetch available pools and profiles.
- Create a customer route and store the returned ID in your database.
- Show the TXT record and DNS instructions to the customer.
- Verify ownership and test the backend connection.
- Expose status and basic monitoring to the customer.
Secrets and retries
Keep keys out of frontend code and logs. Use distinct keys for integrations so they can be revoked independently. The API does not promise Idempotency-Key support: after a route-creation timeout, check whether the resource already exists before repeating POST.