synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7fbb3ced5bcdd5336cbead65f617ba5f044c5971
coder/docs/reference/api/prebuilds.md
Sas Swart 01163ea57b feat: allow users to pause prebuilt workspace reconciliation (#18700) 
This PR provides two commands:
* `coder prebuilds pause`
* `coder prebuilds resume`

These allow the suspension of all prebuilds activity, intended for use
if prebuilds are misbehaving.
2025-07-02 15:05:42 +00:00

2.4 KiB
Generated
Raw Blame History

Prebuilds

Get prebuilds settings

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/prebuilds/settings \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /prebuilds/settings

Example responses

200 Response

{
  "reconciliation_paused": true
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.PrebuildsSettings

To perform this operation, you must be authenticated. Learn more.

Update prebuilds settings

Code samples

# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/prebuilds/settings \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PUT /prebuilds/settings

Body parameter

{
  "reconciliation_paused": true
}

Parameters

Name In Type Required Description
body body codersdk.PrebuildsSettings true Prebuilds settings request

Example responses

200 Response

{
  "reconciliation_paused": true
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.PrebuildsSettings
304 Not Modified Not Modified

To perform this operation, you must be authenticated. Learn more.