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.

57 lines
1.5 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: REST API
description: "Reference for the Coder REST API, including endpoints, authentication, and schemas."
icon_path: "./images/icons/api.svg"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
2023-07-13 09:24:09 -04:00
Get started with the Coder API:
## Quickstart
Generate a token on your Coder deployment by visiting:
````txt
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
````sh
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
## Request size limits
An endpoint that accepts a request body reads at most 4 MiB of it, unless it
sets a limit of its own.
An endpoint that sets its own limit declares `413` in this reference and
names the limit in the description, so the per-endpoint page is where to look
one up. A few endpoints answer `413` for a reason other than the size of
the request body, and their descriptions say so.
A body that exceeds the limit that applies to it is answered with
`413 Payload Too Large`, and the response names the limit it exceeded:
````json
{
"message": "Request body too large.",
"detail": "Maximum request body size is 4194304 bytes."
}
````
The limits are fixed. There is no deployment option that raises them.
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>