Files
coder/docs/reference/api/prebuilds.md

2.5 KiB
Generated

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 /api/v2/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 /api/v2/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.