» Network Areas - Operator HTTP API

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 see the Network Segments Guide 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, 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

» Sample Response

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