Files
coder/docs/reference/api/index.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

29 lines
566 B
Markdown
Raw Normal View History

# API
2023-07-13 09:24:09 -04:00
Get started with the Coder API:
## Quickstart
Generate a token on your Coder deployment by visiting:
````shell
2023-07-13 09:24:09 -04:00
https://coder.example.com/settings/tokens
````
2023-07-13 09:24:09 -04:00
List your workspaces
````shell
2023-07-13 09:24:09 -04:00
# CLI
curl https://coder.example.com/api/v2/workspaces?q=owner:me \
-H "Coder-Session-Token: <your-token>"
````
2023-07-13 09:24:09 -04:00
## Use cases
2024-10-05 08:52:04 -07:00
See some common [use cases](../../reference/index.md#use-cases) for the REST API.
2023-07-13 09:24:09 -04:00
## Sections
<children>
This page is rendered on https://coder.com/docs/reference/api. Refer to the other documents in the `api/` directory.
</children>