go-unifi

Delete Vouchers

Remove Hotspot vouchers based on the specified filter criteria. <details> <summary>Filterable properties (click to expand)</summary> |Name|Type|Allowed functions| |-|-|-| |`id`|`UUID`|`eq` `ne` `in` `notIn`| |`createdAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`| |`name`|`STRING`|`eq` `ne` `in` `notIn` `like`| |`code`|`STRING`|`eq` `ne` `in` `notIn`| |`authorizedGuestLimit`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| |`authorizedGuestCount`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`| |`activatedAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`| |`expiresAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`| |`expired`|`BOOLEAN`|`eq` `ne`| |`timeLimitMinutes`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`| |`dataUsageLimitMBytes`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| |`rxRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| |`txRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| </details>

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

Remove Hotspot vouchers based on the specified filter criteria.

NameTypeAllowed functions
idUUIDeq ne in notIn
createdAtTIMESTAMPeq ne gt ge lt le
nameSTRINGeq ne in notIn like
codeSTRINGeq ne in notIn
authorizedGuestLimitINTEGERisNull isNotNull eq ne gt ge lt le
authorizedGuestCountINTEGEReq ne gt ge lt le
activatedAtTIMESTAMPeq ne gt ge lt le
expiresAtTIMESTAMPeq ne gt ge lt le
expiredBOOLEANeq ne
timeLimitMinutesINTEGEReq ne gt ge lt le
dataUsageLimitMBytesINTEGERisNull isNotNull eq ne gt ge lt le
rxRateLimitKbpsINTEGERisNull isNotNull eq ne gt ge lt le
txRateLimitKbpsINTEGERisNull isNotNull eq ne gt ge lt le
X-Api-Key<token>

UniFi API key. Create one under Control Plane → Admins & Users → your admin → Create API Key (requires controller 9.0.114+).

In: header

Path Parameters

siteId*string

Query Parameters

filter*string

Response Body

application/json

curl -X DELETE "https://example.com/v1/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/hotspot/vouchers?filter=string"
{  "vouchersDeleted": 0}