Version 2.1.1792967583 · latest Download OpenAPI Markdown

IP sites

Sites served on IPs with custom ports; the IPs must first be selected in the user package.

ip-sitesIP product lineAuthentication: User (some parameters admin only)7 endpoints

List IP sites

GET/api/v2/ip-sites

Authentication: User (some parameters admin only)

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data
upid	integer	—	Filter by user package.

POST/api/v2/ip-sites

Authentication: User (some parameters admin only)

Field	Type	Required	Description
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data

Field	Type	Required	Description
config	object	—	Node configuration fields (same as the site config; kind is always ip, and listen_addrs is derived from the bindings at publish time).
enabled	boolean	—	Whether enabled
ip_ids	integer[]	—	IDs of the bound pool IPs, in order.
name	string	—	Name
origins	IpSiteOrigin[]	—	Origin servers.
stop_code	integer	—	0 = normal; non-zero = every request returns this status code (set by admins or billing).
upid	integer	—	User package ID.

GET/api/v2/ip-sites/available-ips

Authentication: User (some parameters admin only)

Field	Type	Required	Description
upid	integer	Required	User package ID.
scope	string	—	pool = the whole pool; mine = only the IPs already selected. Values `["pool","mine"]`Default `"pool"`
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data

POST/api/v2/ip-sites/port-check

Authentication: User (some parameters admin only)

Field	Type	Required	Description
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data

Field	Type	Required	Description
http_ports	integer[]	—	HTTP ports to check; ports outside 1-65535 are not rejected but reported as range.
https_ports	integer[]	—	HTTPS ports to check; ports outside 1-65535 are not rejected but reported as range.
ip_ids	integer[]	Required	IDs of the bound pool IPs, in order.
site_id	integer	—	Pass when editing a site: ports held by this site itself are not counted as occupied.
upid	integer	Required	User package ID.

GET/api/v2/ip-sites/{id}

Authentication: User (some parameters admin only)

PUT/api/v2/ip-sites/{id}

Authentication: User (some parameters admin only)

Field	Type	Required	Description
config	object	—	Node configuration fields (same as the site config; kind is always ip, and listen_addrs is derived from the bindings at publish time).
enabled	boolean	—	Whether enabled
ip_ids	integer[]	—	IDs of the bound pool IPs, in order.
name	string	—	Name
origins	IpSiteOrigin[]	—	Origin servers.
stop_code	integer	—	0 = normal; non-zero = every request returns this status code (set by admins or billing).
upid	integer	—	User package ID.

DELETE/api/v2/ip-sites/{id}

Authentication: User (some parameters admin only)

Field	Type	Required	Description
access_addrs	string[]	—	Access address in ip:port form. read-only
config	object	—	Node configuration fields (same as the site config; kind is always ip, and listen_addrs is derived from the bindings at publish time).
created_at	string	—	Created at read-only
enabled	boolean	—	Whether enabled
hints	string[]	—	Hints (e.g. the node reported no listening ports, so that check was skipped). read-only
http_ports	integer[]	—	HTTP ports to check; ports outside 1-65535 are not rejected but reported as range.
https_ports	integer[]	—	HTTPS ports to check; ports outside 1-65535 are not rejected but reported as range.
id	integer	—	Record ID read-only
ip_ids	integer[]	—	IDs of the bound pool IPs, in order.
ips	IpSiteIp[]	—	Details of the bound pool IPs. read-only
items	AvailableIp[]	—	Items on this page
name	string	—	Name
origins	IpSiteOrigin[]	—	Origin servers.
ports	object[]	—	Per-port check results.
site_id	integer	—	Pass when editing a site: ports held by this site itself are not counted as occupied.
stop_code	integer	—	0 = normal; non-zero = every request returns this status code (set by admins or billing).
tenant_id	integer	—	Owner tenant (user) ID read-only
updated_at	string	—	Updated at read-only
upid	integer	—	User package ID.