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

58 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
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.
---
2021-10-21 00:37:01 +00:00
# Network Segments - Operator HTTP API
2017-08-31 18:19:08 +00:00
<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 check the [Network Segments documentation](/consul/docs/enterprise/network-segments/network-segments-overview) 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
[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).
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
### Query Parameters
2017-08-31 18:19:08 +00:00
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
the datacenter of the agent being queried.
2017-08-31 18:19:08 +00:00
### 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"]
```