588bca2207
* Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
58 lines
1.8 KiB
Plaintext
58 lines
1.8 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: Network Segments - Operator - HTTP API
|
|
description: |-
|
|
The /operator/segment endpoint exposes the network segment information via
|
|
Consul's HTTP API.
|
|
---
|
|
|
|
# Network Segments - Operator HTTP API
|
|
|
|
<EnterpriseAlert />
|
|
|
|
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](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 check the [Network Segments documentation](/consul/docs/enterprise/network-segments/network-segments-overview) 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](/consul/api-docs/features/blocking),
|
|
[consistency modes](/consul/api-docs/features/consistency),
|
|
[agent caching](/consul/api-docs/features/caching), and
|
|
[required ACLs](/consul/api-docs/api-structure#authentication).
|
|
|
|
| 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
|
|
|
|
```shell-session
|
|
$ curl \
|
|
http://127.0.0.1:8500/v1/operator/segment
|
|
```
|
|
|
|
### Sample Response
|
|
|
|
```json
|
|
["", "alpha", "beta"]
|
|
```
|