License license

License status and validity of this installation; once locked after expiry, new sites, forwardings and nodes cannot be created.

Pick an endpoint to see its example call on the right.

Operations and systemAuthentication: User1 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

License object

FieldTypeDescription
customerstring Customer name on the license.
expires_atstring Validity end of the last accepted license.
featuresLicenseFeature[] Features enabled by the license.
grace_untilstring End of the grace period; after it, creating new items is locked. After a disable notice, the earlier of this and first notice + 24 hours.
install_idstring Installation ID (install key fingerprint).
last_ok_atstring Time of the last successful fetch; omitted if there has never been one.
lockedboolean Whether create-type operations (creating sites, TCP/UDP forwardings, IP sites, nodes, node enrollment tokens and approvals) are locked.
readonly_daysinteger Read-only buffer in days (set by the provider, 7 if not set). For this many days after a protection feature's not_after, waf_enhanced is read-only and xdp and l2 are frozen; after that they degrade with settings kept, and renewing restores them right away.
reasonstring Why the last fetch failed (protocol error code, http_<status>:<code>, unreachable, clock_behind); empty on success. After a disable notice (within the buffer or denied), the reason it was disabled.
statusstring pending: never fetched successfully (within first-run grace); active: last fetch succeeded; grace: last fetch failed (including the 24-hour buffer after a disable notice) but still within grace; locked: grace expired; denied: this installation was disabled by the platform operator and the 24-hour buffer has passed; it recovers on the next fetch once the operator lifts it.
Values ["pending","active","grace","locked","denied"]
stop_atstring When a trial stops serving (plan expiry + 7 days); present only when trial is true.
trialboolean Whether the last accepted license is a trial license (not sent by the provider means not a trial). Trials get no 7/3/1-day expiry reminders. At stop_at every node stops serving with settings kept; buying a full license or moving stop_at later restores service within about a minute.
trial_stoppedboolean Whether the trial has reached stop_at by now, judged by the latest time the controller has seen (turning the local clock back does not restore service early). false when not a trial.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command