Files
coder/docs/reference/api/index.md
T
Michael Suchacz 9cd38b5373 feat!: remove the Tasks API from coderd and codersdk (#28789)
Removes the Tasks API and task orchestration from coderd and codersdk:
the `/api/v2/tasks` handlers, task middleware and search filters, task
name generation, autobuild pause/resume logic, task notification
enqueues, telemetry, and the codersdk task types. Regenerates apidoc,
the API reference docs, and `typesGenerated.ts`.

**Breaking change:** the Tasks API is removed; requests to
`/api/v2/tasks` fail. Tasks was deprecated in v2.34.

**Stack context:** Coder Tasks removal stack (CODAGT-642): #28743
frontend → #28788 CLI → #28789 API → #28790 provisioner → #29084
notifications → #29085 build reasons → #29086 tables → #28750
permissions. The last four PRs replace the single data-drop migration
that used to live in #28750; each carries one concern and its own
migration number.

**Why:** with the UI (#28743) and CLI (#28788) gone, this deletes the
server surface. Database tables, RBAC, and notification templates stay
until the top of the stack so every layer builds and migrates
independently.

**What to scrutinize:**
- The `enable-ai-tasks` option is removed outright (review feedback):
configs still carrying `enableAITasks` fail to parse until the key is
deleted.
- provisionerdserver now writes `HasAITask: false` on template/build
flags; the column and these lines are dropped in #29085.
- `codersdk.ResourceTypeTask` stays so audit logs recorded before the
removal keep rendering.

**Validation:** `go build ./...`, `go vet ./...`, `go test
./codersdk/...`, site biome and tsc, CLI goldens regenerated, pre-commit
hooks.

**Size:** +242/-10,792 over 76 files; additions are regenerated
docs/goldens and test fixture updates.

> Created by Xum (AI agent) on behalf of @ibetitsmike.
2026-09-11 01:48:56 +00:00

58 lines
1.5 KiB
Markdown
Generated

---
# 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 -->
Get started with the Coder API:
## Quickstart
Generate a token on your Coder deployment by visiting:
````txt
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](../../reference/index.md#use-cases) for the REST API.
## 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.
## Sections
<children>
This page is rendered on https://coder.com/docs/reference/api. Refer to the other documents in the `api/` directory.
</children>