docs: add custom API use cases (#8445)

This commit is contained in:
Ben Potter
2023-07-13 13:24:09 +00:00
committed by GitHub
parent ebdc510f12
commit 44e25185ff
7 changed files with 250 additions and 35 deletions
+23 -1
View File
@@ -1,4 +1,26 @@
Get started with Coder API:
Get started with the Coder API:
## Quickstart
Generate a token on your Coder deployment by visiting:
```sh
https://coder.example.com/settings/tokens
```
List your workspaces
```sh
# CLI
curl https://coder.example.com/api/v2/workspaces?q=owner:me \
-H "Coder-Session-Token: <your-token>"
```
## Use cases
See some common [use cases](../admin/automation.md#use-cases) for the REST API.
## Sections
<children>
This page is rendered on https://coder.com/docs/coder-oss/api. Refer to the other documents in the `api/` directory.