Version 2.1.1792967583 · latest Download OpenAPI Markdown

Upgrade packs

Quotas or features bought per unit on top of a base package.

package-upgradesPackagesAuthentication: Admin only5 endpoints

List upgrade packs

GET/api/v2/package-upgrades
Authentication: Admin only

Query parameters

FieldTypeRequiredDescription
pageinteger— Page number, starting from 1
Default 1
page_sizeinteger— Items per page
Default 20
sortstring— Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`

Create upgrade pack

POST/api/v2/package-upgrades
Authentication: Admin only

Request body application/json

FieldTypeRequiredDescription
amountinteger— Amount added per unit; always 1 for feature items (custom_cc_rule/websocket).
bind_packagesinteger[]— Only these base packages may buy it; empty = no restriction.
desstring— Description
enabledboolean— Whether enabled
namestringRequired Name
price_centsintegerRequired Price per unit per month, in cents.
typestringRequired Add-on item: traffic GB, domains, non-standard ports, TCP/UDP forwarding ports, custom CC, bandwidth Mbps, connections, WebSocket, dedicated IPs.
Values ["traffic","domain","http_port","stream_port","custom_cc_rule","bandwidth","connection","websocket","ip_num"]

Get upgrade pack

GET/api/v2/package-upgrades/{id}
Authentication: Admin only

Update upgrade pack

PUT/api/v2/package-upgrades/{id}
Authentication: Admin only

Request body application/json

FieldTypeRequiredDescription
amountinteger— Amount added per unit; always 1 for feature items (custom_cc_rule/websocket).
bind_packagesinteger[]— Only these base packages may buy it; empty = no restriction.
desstring— Description
enabledboolean— Whether enabled
namestringRequired Name
price_centsintegerRequired Price per unit per month, in cents.
typestringRequired Add-on item: traffic GB, domains, non-standard ports, TCP/UDP forwarding ports, custom CC, bandwidth Mbps, connections, WebSocket, dedicated IPs.
Values ["traffic","domain","http_port","stream_port","custom_cc_rule","bandwidth","connection","websocket","ip_num"]

Delete upgrade pack

DELETE/api/v2/package-upgrades/{id}
Authentication: Admin only

Upgrade packs object

FieldTypeRequiredDescription
amountinteger— Amount added per unit; always 1 for feature items (custom_cc_rule/websocket).
bind_packagesinteger[]— Only these base packages may buy it; empty = no restriction.
created_atstring— Created at
read-only
desstring— Description
enabledboolean— Whether enabled
idinteger— Record ID
read-only
namestring— Name
price_centsinteger— Price per unit per month, in cents.
typestring— Add-on item: traffic GB, domains, non-standard ports, TCP/UDP forwarding ports, custom CC, bandwidth Mbps, connections, WebSocket, dedicated IPs.
Values ["traffic","domain","http_port","stream_port","custom_cc_rule","bandwidth","connection","websocket","ip_num"]
updated_atstring— Updated at
read-only