License API — getting started

Scope and environments

The License API manages only your own Enterprise postpaid licenses for Hosting Manager (SHM), DNS Manager (SDM) and Backup Manager (SBM). It does not expose servers, websites, email, DNS zones, other customers or prepaid licenses.

Public API base URL for this environment:

https://synconix.com/api/enterprise/v1

Send requests to this public endpoint; Synconix securely forwards them to its internal license service. Direct backend access is not supported. Manage credentials in Client Area → API. Development and production have separate keys, customers and licenses. Development credentials never authenticate to production.

Create a restricted API key

1. Sign in as the main customer account owner. Synconix must have enabled Enterprise billing.
2. Open Client Area → API and choose Create API key.
3. Choose Read only for listing/detail/catalog, or Manage licenses for orders and lifecycle actions.
4. Enter the public outbound IP of your automation server, or a narrow IPv4/IPv6 CIDR range. This is not necessarily the licensed server’s IP.
5. Set an expiry between 1 and 365 days or choose Unlimited (no expiry) and save the one-time secret in a secret manager.

At least one allowed IP is mandatory. Up to 20 IP entries and 20 active keys are allowed. IPv4 wildcards such as 1.1.1.* are accepted and normalized to 1.1.1.0/24. Hostnames, unrestricted wildcards, wider wildcard forms and /0 are rejected. To change IPs or permissions, create a replacement, switch your integration, then revoke the old key. Revocation is immediate and does not alter licenses.

Authentication

Send the key only in the Authorization header over HTTPS. Never place it in query strings, frontend JavaScript, repositories, tickets or logs. Set SYNCONIX_API_KEY in your server’s secret environment; the example commands read it without embedding it in the URL.

curl --fail-with-body -H "Authorization: Bearer $SYNCONIX_API_KEY" -H "Accept: application/json" "https://synconix.com/api/enterprise/v1/catalog"

Only hashed keys are stored by Synconix. Revoked/expired keys, disabled owners, sub-client accounts and accounts without Enterprise eligibility cannot authenticate. IP restrictions are enforced by the backend, not by the UI.

Provisioning workflow

1. GET /catalog to obtain enabled products, account options, prices and the current terms version.
2. POST /licenses with explicit purchase declarations and a unique Idempotency-Key.
3. Save the order ID and all returned license UUIDs. If fulfillment is pending, poll the operation with the same idempotency key.
4. POST /licenses/{license}/install-link for a pending_key license.
5. Run the returned installer command on the intended server. The installer performs the one-time cryptographic activation.
6. GET /licenses/{license} to confirm the active state and registered IP.

API access does not waive billing, review, contract-confirmation or security controls. Creating licenses creates a normal attributable order. Do not call the API from browser applications.