Swarmz

Introduction

The server-to-server integration surface for hosting companies reselling Swarmz — provision tenants, mint white-label dashboard sessions, meter usage, and run the full account lifecycle from your own billing system.

The Swarmz Platform API is the integration surface for hosting companies that resell Swarmz to their own customers. The same surface powers our WHMCS module, the upcoming Upmind module, and any custom control panel a partner builds.

With it you can:

  • Provision a fully-isolated Swarmz workspace — a tenant — for each of your customers.
  • Drop that customer straight into a white-labelled editor with one-click single sign-on.
  • Meter credit and cloud usage per tenant for reconciliation.
  • Change a tenant's plan, top up credits, and run the complete suspend → unsuspend → terminate lifecycle.

Everything is keyed to your account: a request can only ever see and act on your tenants.

Base URL

https://api.swarmz.net/functions/v1

Every endpoint is POST, accepts and returns JSON, and is authenticated by a bearer key on each call. TLS only.

Server-to-server only

Your sk_live_ key carries full access to your platform account. Make these calls from your backend — never from a browser or client app, and never commit the key to source control.

Start here

Authentication

Bearer keys, hashing, rotation, and the auth error model.

Data model

How platform accounts, tenants, and web-host users fit together.

Create a tenant

Provision an isolated workspace for one of your customers.

Single sign-on

Mint a redirect that lands a customer in their editor, logged in.

Authentication

Every Platform API call is authenticated by a bearer key scoped to your platform account. Keys are stored as a hash, shown once, and rotated through support.

On this page

Base URL
Start here