2025-01-03 18:12:59 +05:00
|
|
|
# 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:
|
|
|
|
|
|
2025-01-03 18:12:59 +05:00
|
|
|
````shell
|
2023-07-13 09:24:09 -04:00
|
|
|
https://coder.example.com/settings/tokens
|
2025-01-03 18:12:59 +05:00
|
|
|
````
|
2023-07-13 09:24:09 -04:00
|
|
|
|
|
|
|
|
List your workspaces
|
|
|
|
|
|
2025-01-03 18:12:59 +05:00
|
|
|
````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>"
|
2025-01-03 18:12:59 +05:00
|
|
|
````
|
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
|
2022-12-19 18:43:46 +01:00
|
|
|
|
|
|
|
|
<children>
|
2024-08-13 18:39:46 +03:00
|
|
|
This page is rendered on https://coder.com/docs/reference/api. Refer to the other documents in the `api/` directory.
|
2022-12-19 18:43:46 +01:00
|
|
|
</children>
|