website: document regions endpoint

This commit is contained in:
Ryan Uber 2015-11-23 22:41:41 -08:00
parent a230a70cc7
commit 714450c6a5
3 changed files with 42 additions and 0 deletions

View File

@ -0,0 +1,38 @@
---
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>

View File

@ -89,6 +89,10 @@
</ul> </ul>
</li> </li>
<li<%= sidebar_current("docs-http-regions") %>>
<a href="/docs/http/regions.html">Regions</a>
</li>
<li<%= sidebar_current("docs-http-status") %>> <li<%= sidebar_current("docs-http-status") %>>
<a href="/docs/http/status.html">Status</a> <a href="/docs/http/status.html">Status</a>
</li> </li>