synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
18a97c6f5973eb70ad5ee25e59b585333ba28a08
coder/docs/admin/automation.md
Ben Potter 2a1bfb3e44 docs: API tokens & CI automation (#4510) 
* reword: chore: add CI to dogfood template

* use hardcoded URL

* use consistent name for tokens

* chore: add docs for template change management

* add an example

* fix case
2022-10-12 15:43:59 +00:00

1.1 KiB
Raw Blame History

Automation

We recommend automating Coder deployments through the CLI. Examples include updating templates via CI/CD pipelines.

Tokens

Long-lived tokens can be generated to perform actions on behalf of your user account:

coder tokens create

CLI

You can use tokens with the CLI by setting the --token CLI flag or the CODER_SESSION_TOKEN environment variable.

export CODER_URL=https://coder.example.com
export CODER_SESSION_TOKEN=*****
coder workspaces ls

REST API

You can use tokens with the Coder's REST API using the Coder-Session-Token HTTP header.

curl 'https://dev.coder.com/api/v2/workspaces' \
  -H 'Coder-Session-Token: *****'

At this time, we do not publish an API reference. However, codersdk can be grepped to find the necessary routes and payloads.

Golang SDK

Coder publishes a public Golang SDK for Coder. This is consumed by the CLI package.