Network Segments - Operator HTTP API

This feature requires Consul Enterprise(opens in new tab).

The /operator/segment endpoint provides tools to manage network segments via Consul's HTTP API.

The network area functionality described here is available only in Consul Enterprise version 0.9.3 and later. Network segments are operator-defined sections of agents on the LAN, typically isolated from other segments by network configuration.

Please check the Network Segments documentation for more details.

List Network Segments

This endpoint lists all network areas.

Method	Path	Produces
`GET`	`/operator/segment`	`application/json`

The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.

Blocking Queries	Consistency Modes	Agent Caching	ACL Required
`NO`	`none`	`none`	`operator:read`

Query Parameters

dc (string: "") - Specifies the datacenter to query. This will default to the datacenter of the agent being queried.

Sample Request

$ curl \
    http://127.0.0.1:8500/v1/operator/segment

Sample Response

["", "alpha", "beta"]