github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'be39fb20cc'
${ noResults }
consul/website/source/api/operator/segment.html.md

1.8 KiB
Raw Blame History

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

Network Areas - Operator HTTP API

The /operator/segment endpoint provides 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 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"]