The API reference is generated from Swagger comments and struct tags, and several `enums:"..."` tags narrowed a named enum type, so the docs omitted values the server returns. For example, `User.status` listed only `active` and `suspended`, not `dormant`, and `TemplateVersion.warnings` listed `DEPRECATED_PARAMETERS`, which is not a value of the type. Remove 34 `enums` tags that narrow or duplicate a named type so the referenced type's full value list is used. Tags that describe an intentional subset stay: ACL role fields (which omit the `""` deleted sentinel used only in update requests), `APIKey.scope`, and plain-string fields. `Template.provisioner` keeps its tag because `.swaggo` replaces `ProvisionerType` with `string`. Also fix enum defects that break code generators: - The provisioner jobs and daemons `status` query parameters listed their enum twice (Swagger 2.0 requires unique `enum` items) or with the wrong type. Both are now `[]codersdk.ProvisionerJobStatus` and `[]codersdk.ProvisionerDaemonStatus`, matching what each handler parses, including comma-separated values. The daemons route previously documented job statuses, which the handler rejects with a 500. - Replace the `_` zero placeholder of `WatchErrorCode` with `iota + 1`, so the spec no longer lists 0 or `x-enum-varnames: ["_", ...]`. Wire values are unchanged. Where the narrowed tag hid values the server returns, the SDK type now includes them: `LoginTypeOAuth2ProviderApp`, `BuildReasonAutodelete`, and `MissingTemplateParameter` widen the generated TypeScript unions. The dashboard attributes `autodelete` builds to Coder like other system builds. `APIKey.login_type` and `AuthorizationCheck.action` set explicit examples so the generated samples stay representative. `TestSwaggerEnumsNotNarrowed` fails when a property's enum list drops values of its named type (other than the 15 allowlisted intentional subsets), lists a value the type lacks, or repeats a value. Part of DOCS-1122, split from #30121. --- 🤖 Built with AI assistance.
7.1 KiB
Generated
7.1 KiB
Generated
title
| title |
|---|
| Provisioning |
Get provisioner daemons
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerdaemons \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/organizations/{organization}/provisionerdaemons
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
organization |
path | string(uuid) | true | Organization ID |
limit |
query | integer | false | Page limit |
ids |
query | array[string] | false | Filter results by provisioner daemon IDs (UUIDs) |
status |
query | array[string] | false | Filter results by status |
tags |
query | string | false | Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'}) |
Enumerated Values
| Parameter | Value(s) |
|---|---|
status |
busy, idle, offline |
Example responses
200 Response
[
{
"api_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"current_job": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "pending",
"template_display_name": "string",
"template_icon": "string",
"template_name": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key_id": "1e779c8a-6786-4c89-b7c3-a6666f5fd6b5",
"key_name": "string",
"last_seen_at": "2019-08-24T14:15:22Z",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"previous_job": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "pending",
"template_display_name": "string",
"template_icon": "string",
"template_name": "string"
},
"provisioners": [
"string"
],
"status": "offline",
"tags": {
"property1": "string",
"property2": "string"
},
"version": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | array of codersdk.ProvisionerDaemon |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
[array item] |
array | false | ||
» api_version |
string | false | ||
» created_at |
string(date-time) | false | ||
» current_job |
codersdk.ProvisionerDaemonJob | false | ||
»» id |
string(uuid) | false | ||
»» status |
codersdk.ProvisionerJobStatus | false | ||
»» template_display_name |
string | false | ||
»» template_icon |
string | false | ||
»» template_name |
string | false | ||
» id |
string(uuid) | false | ||
» key_id |
string(uuid) | false | ||
» key_name |
string | false | Optional fields. | |
» last_seen_at |
string(date-time) | false | ||
» name |
string | false | ||
» organization_id |
string(uuid) | false | ||
» previous_job |
codersdk.ProvisionerDaemonJob | false | ||
» provisioners |
array | false | ||
» status |
codersdk.ProvisionerDaemonStatus | false | ||
» tags |
object | false | ||
»» [any property] |
string | false | ||
» version |
string | false |
Enumerated Values
| Property | Value(s) |
|---|---|
status |
busy, canceled, canceling, failed, idle, offline, pending, running, succeeded, unknown |
To perform this operation, you must be authenticated. Learn more.