Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
小 白蛋
Nomad
Commits
6d44b632
Unverified
Commit
6d44b632
authored
8 years ago
by
Seth Vargo
Browse files
Options
Download
Email Patches
Plain Diff
Migrate regions APIs
parent
1e05ae53
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
website/source/api/regions.html.md
+42
-0
website/source/api/regions.html.md
website/source/docs/http/regions.html.md
+0
-38
website/source/docs/http/regions.html.md
with
42 additions
and
38 deletions
+42
-38
website/source/api/regions.html.md
0 → 100644
+
42
-
0
View file @
6d44b632
---
layout
:
api
page_title
:
Regions - HTTP API
sidebar_current
:
api-regions
description
:
|-
The /regions endpoints list all known regions.
---
# Regions HTTP API
The
`/regions`
endpoints list all known regions.
## List Regions
| Method | Path | Produces |
| ------ | ---------------------------- | -------------------------- |
|
`GET`
|
`/status/regions`
|
`application/json`
|
The table below shows this endpoint's support for
[
blocking queries
](
/api/index.html#blocking-queries
)
,
[
consistency modes
](
/api/index.html#consistency-modes
)
, and
[
required ACLs
](
/api/index.html#acls
)
.
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------ |
|
`NO`
|
`none`
|
`none`
|
### Sample Request
```
text
$ curl \
https://nomad.rocks/v1/status/regions
```
### Sample Response
```
json
[
"region1"
,
"region2"
]
```
This diff is collapsed.
Click to expand it.
website/source/docs/http/regions.html.md
deleted
100644 → 0
+
0
-
38
View file @
1e05ae53
---
layout
:
"
http"
page_title
:
"
HTTP
API:
/v1/regions"
sidebar_current
:
"
docs-http-regions"
description
:
>
The '/v1/regions' endpoint lists the known cluster regions.
---
# /v1/regions
## GET
<dl>
<dt>
Description
</dt>
<dd>
Returns the known region names.
</dd>
<dt>
Method
</dt>
<dd>
GET
</dd>
<dt>
URL
</dt>
<dd>
`/v1/regions`
</dd>
<dt>
Parameters
</dt>
<dd>
None
</dd>
<dt>
Returns
</dt>
<dd>
```javascript
["region1","region2"]
```
</dd>
</dl>
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment