Reseller API

Before you start

How to get ZoltVPN Reseller API access: have it turned on, create a key with scopes, an expiry and allowed IPs, and keep the key safe.

  1. We turn the API on for your account. Until then the API page says "API access is off" and no key can be created. Ask your account manager.
  2. In the portal, open API → Keys → Create key and choose:
    • a name (for example "My CRM");
    • the scopes;
    • an optional expiry;
    • optional allowed IP addresses.
  3. Copy the key when it is shown. It is shown once only and we store only a fingerprint of it, so nobody can show it again. If you lose it, revoke it and create a new one.

A key looks like zrk_3f9a1c2b7d4e8f60_Qm9vZ2xlLWlzLW5vdC1hLXNlY3JldC1rZXktMTIzNDU2. The part up to the second _ is the key's public prefix, and the portal shows it so you can tell keys apart. The rest is the secret.