consul/website/pages/api-docs/operator/segment.mdx

60 lines
1.8 KiB
Plaintext
Raw Normal View History

2017-08-31 18:19:08 +00:00
---
layout: api
page_title: Network Segments - Operator - HTTP API
sidebar_title: Segment
2017-08-31 18:19:08 +00:00
description: |-
2017-09-01 19:42:54 +00:00
The /operator/segment endpoint exposes the network segment information via
2017-08-31 18:19:08 +00:00
Consul's HTTP API.
---
# Network Areas - Operator HTTP API
<EnterpriseAlert />
2017-09-01 19:42:54 +00:00
The `/operator/segment` endpoint provides tools to manage network segments via
2017-08-31 18:19:08 +00:00
Consul's HTTP API.
The network area functionality described here is available only in
[Consul Enterprise](https://www.hashicorp.com/products/consul/) 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](https://learn.hashicorp.com/consul/day-2-operations/network-segments) for more details.
2017-08-31 18:19:08 +00:00
## List Network Segments
This endpoint lists all network areas.
2020-04-06 20:27:35 +00:00
| Method | Path | Produces |
| ------ | ------------------- | ------------------ |
| `GET` | `/operator/segment` | `application/json` |
2017-08-31 18:19:08 +00:00
The table below shows this endpoint's support for
2020-04-09 23:46:54 +00:00
[blocking queries](/api/features/blocking),
[consistency modes](/api/features/consistency),
[agent caching](/api/features/caching), and
2020-04-09 23:20:00 +00:00
[required ACLs](/api#authentication).
2017-08-31 18:19:08 +00:00
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | --------------- |
| `NO` | `none` | `none` | `operator:read` |
2017-08-31 18:19:08 +00:00
### 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
2020-05-19 18:32:38 +00:00
```shell-session
2017-08-31 18:19:08 +00:00
$ curl \
http://127.0.0.1:8500/v1/operator/segment
2017-08-31 18:19:08 +00:00
```
### Sample Response
```json
2020-04-06 20:27:35 +00:00
["", "alpha", "beta"]
```