UBubiquiti
Hotspot

Get Voucher Details

Retrieve details of a specific Hotspot voucher.

get/v1/sites/{siteId}/hotspot/vouchers/{voucherId}

Request

Path parameters

voucherIdstring uuid required
siteIdstring uuid required

Response

OK

idstring uuid required
createdAtstring date-time required
namestring required

Voucher note, may contain duplicate values across multiple vouchers

codestring required

Secret code to active the voucher using the Hotspot portal

authorizedGuestLimitinteger

(Optional) limit for how many different guests can use the same voucher to authorize network access

authorizedGuestCountinteger required

For how many guests the voucher has been used to authorize network access

activatedAtstring date-time

(Optional) timestamp when the voucher has been activated (authorization time of the first guest)

expiresAtstring date-time

(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access

expiredboolean required

Whether the voucher has been expired and can no longer be used to authorize network access

timeLimitMinutesinteger required

How long (in minutes) the voucher will provide access to the network since authorization of the first guest. Subsequently connected guests, if allowed, will share the same expiration time.

dataUsageLimitMBytesinteger

(Optional) data usage limit in megabytes

rxRateLimitKbpsinteger

(Optional) download rate limit in kilobits per second

txRateLimitKbpsinteger

(Optional) upload rate limit in kilobits per second

Example response

{
  "name": "hotel-guest",
  "authorizedGuestLimit": 1,
  "timeLimitMinutes": 1440,
  "dataUsageLimitMBytes": 1024,
  "rxRateLimitKbps": 1000,
  "txRateLimitKbps": 1000
}

Changes

No recorded changes to this operation across all 1 revision of this API.