File tree 1 file changed +42
-0
lines changed 1 file changed +42
-0
lines changed Original file line number Diff line number Diff line change
1
+ # WorkspaceProxies
2
+
3
+ ## Get site-wide regions for workspace connections
4
+
5
+ ### Code samples
6
+
7
+ ``` shell
8
+ # Example request using curl
9
+ curl -X GET http://coder-server:8080/api/v2/regions \
10
+ -H ' Accept: application/json' \
11
+ -H ' Coder-Session-Token: API_KEY'
12
+ ```
13
+
14
+ ` GET /regions `
15
+
16
+ ### Example responses
17
+
18
+ > 200 Response
19
+
20
+ ``` json
21
+ {
22
+ "regions" : [
23
+ {
24
+ "display_name" : " string" ,
25
+ "healthy" : true ,
26
+ "icon_url" : " string" ,
27
+ "id" : " 497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
28
+ "name" : " string" ,
29
+ "path_app_url" : " string" ,
30
+ "wildcard_hostname" : " string"
31
+ }
32
+ ]
33
+ }
34
+ ```
35
+
36
+ ### Responses
37
+
38
+ | Status | Meaning | Description | Schema |
39
+ | ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- |
40
+ | 200 | [ OK] ( https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [ codersdk.RegionsResponse] ( schemas.md#codersdkregionsresponse ) |
41
+
42
+ To perform this operation, you must be authenticated. [ Learn more] ( authentication.md ) .
You can’t perform that action at this time.
0 commit comments