open-nomad/website/content/api-docs/regions.mdx
Ashlee M Boyer 57f8ebfa26
docs: Migrate link formats (#15779)
* Adding check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* chore: updates link checker workflow hash

* Migrating links to new format

Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 09:31:14 -08:00

37 lines
745 B
Plaintext

---
layout: api
page_title: Regions - HTTP API
description: The /regions endpoints list all known regions.
---
# Regions HTTP API
The `/regions` endpoints list all known regions.
## List Regions
| Method | Path | Produces |
| ------ | ------------- | ------------------ |
| `GET` | `/v1/regions` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
| `NO` | `none` |
### Sample Request
```shell-session
$ curl \
https://localhost:4646/v1/regions
```
### Sample Response
```json
["region1", "region2"]
```