UptimeUptime Wiki

Segment

Parameters

Path Parameters
id*integer

Entity id

Formatint64
Range0 <= value

Try the endpoint

GET
/api/v1/network/segments/{id}

Code example

curl -X GET "https://example.com/api/v1/network/segments/0"

Response example

{  "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}

Response body

200The entity
application/json

A player-created network segment (VXLAN isolation overlay). Small top-level list on WorldSnapshot (msgpack-only, like host_pools). Customer membership is derived engine-side via resolve_vrf; the client builds a host→segment view from carrier_host_ids / dedicated_host_ids.

On this page