Hotspot

Generate Vouchers

Create one or more Hotspot vouchers.

post/v1/sites/{siteId}/hotspot/vouchers

Request

Base URL
https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration
Auth
none declared
TypeScript
https://skmtc.dev/ubiquiti/apis/unifi-network-api/docs/v1/sites/:siteId/hotspot/vouchers/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

siteIdstring uuid required

Request body

countinteger

Number of vouchers to generate

namestring required

Voucher note, duplicated across all generated vouchers

authorizedGuestLimitinteger

(Optional) limit for how many different guests can use the same voucher 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 request

{
  "authorizedGuestLimit": 1
}

Response

Created

Example response

{
  "vouchers": [
    {
      "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.