open-consul/website/source/api/operator/segment.html.md

layout	page_title	sidebar_current	description
api	Network Segments - Operator - HTTP API	api-operator-segment	The /operator/segments endpoints expose the network segment information via Consul's HTTP API.

Network Areas - Operator HTTP API

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

~> Enterprise-only! This API endpoint and functionality only exists in Consul Enterprise. This is not present in the open source version of Consul.

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 see the Network Segments Guide for more details.

List Network Segments

This endpoint lists all network areas.

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

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

Blocking Queries	Consistency Modes	ACL Required
NO	none	operator:read

Parameters

• dc (string: "") - Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as a URL query parameter.

Sample Request

$ curl \
    https://consul.rocks/v1/operator/segment/list

Sample Response

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