Segments
Parameters
Query Parameters
offset?integer
Index of the first item to return. Clamped to the collection length, so an offset past the end is an empty page rather than an error.
Range
0 <= valuelimit?integer
Maximum items to return. CLAMPED to 1000, not obeyed and not refused: a late-campaign save has thousands of hosts and serializing all of them would occupy the single tokio thread to produce a body nobody wants.
Range
1 <= value <= 1000Code example
curl -X GET "https://example.com/api/v1/network/segments"Response example
{ "items": [ { "id": 0, "vni": 0, "name": "string", "tier_rule": "string", "explicit_customer_ids": [ 0 ], "member_count": 0, "carrier_host_ids": [ 0 ], "dedicated_host_ids": [ 0 ], "dedicated_host_count": 0, "dedicated_free_vcpu_milli": 0, "dedicated_total_vcpu_milli": 0, "dedicated_free_mem_mb": 0, "dedicated_total_mem_mb": 0, "dedicated_free_disk_gb": 0, "dedicated_total_disk_gb": 0 } ], "total": 0, "offset": 0, "count": 0}Response body
200One page of resultsapplication/json
Wrapper for a paginated collection.
Every collection endpoint returns this. Unbounded collection responses are not an option: a late-campaign save has thousands of hosts, and serializing all of them would occupy the single tokio thread to produce a body nobody wants.