mirror of
https://github.com/coder/coder.git
synced 2025-07-06 15:41:45 +00:00
28 lines
547 B
Markdown
Generated
28 lines
547 B
Markdown
Generated
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.
|
|
</children>
|