@@ -7,6 +7,15 @@ state: alpha
7
7
To help you integrate Coder into your automated workflows, we've documented our
8
8
API.
9
9
10
+ ## Documentation
11
+
12
+ Please note that the API is under active development; expect breaking changes as
13
+ we finalize the endpoints.
14
+
15
+ <a href =" https://apidocs.coder.com " >
16
+ <button> Swagger Docs </button>
17
+ </a >
18
+
10
19
## Authentication
11
20
12
21
Use of the API requires authentication with a session token. You can generate
@@ -24,15 +33,6 @@ one using the [Coder CLI](../cli/index.md):
24
33
-H " Session-Token: Bk...nt"
25
34
```
26
35
27
- ## Documentation
28
-
29
- Please note that the API is under active development; expect breaking changes as
30
- we finalize the endpoints.
31
-
32
- <a href =" https://apidocs.coder.com " >
33
- <button> Swagger Docs </button>
34
- </a >
35
-
36
36
## Examples
37
37
38
38
These are example Coder API calls for common tasks. Note that the site-manager
@@ -41,8 +41,6 @@ be limited to a user's member role.
41
41
42
42
> Assign your Access URL, Session-Token and other resources like images and
43
43
> workspaces to variables for easier substitution in the curl commands.
44
- >
45
- > For example:
46
44
47
45
``` sh
48
46
export ACCESS_URL " https://coder.acme.com"
@@ -53,7 +51,7 @@ export IMAGE_ID="622b3f6e-dd6fd08-----ba38c73c9639"
53
51
54
52
### Example: get active users in 1 month increments from Jan to March 2022
55
53
56
- > other intervals include 1 week, 1 year, 90 day
54
+ > Other intervals include 1 week, 1 year, 90 day
57
55
58
56
``` sh
59
57
curl --request GET \
0 commit comments