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 /organizations/{organization}/provisionerdaemons

Parameters

NameInTypeRequiredDescription
organizationpathstring(uuid)trueOrganization ID
limitqueryintegerfalsePage limit
idsqueryarray(uuid)falseFilter results by job IDs
statusquerystringfalseFilter results by status
tagsqueryobjectfalseProvisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})

Enumerated Values

ParameterValue
statuspending
statusrunning
statussucceeded
statuscanceling
statuscanceled
statusfailed
statusunknown
statuspending
statusrunning
statussucceeded
statuscanceling
statuscanceled
statusfailed

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

StatusMeaningDescriptionSchema
200OKOKarray of codersdk.ProvisionerDaemon

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
[array item]arrayfalse
» api_versionstringfalse
» created_atstring(date-time)false
» current_jobcodersdk.ProvisionerDaemonJobfalse
»» idstring(uuid)false
»» statuscodersdk.ProvisionerJobStatusfalse
»» template_display_namestringfalse
»» template_iconstringfalse
»» template_namestringfalse
» idstring(uuid)false
» key_idstring(uuid)false
» key_namestringfalseOptional fields.
» last_seen_atstring(date-time)false
» namestringfalse
» organization_idstring(uuid)false
» previous_jobcodersdk.ProvisionerDaemonJobfalse
» provisionersarrayfalse
» statuscodersdk.ProvisionerDaemonStatusfalse
» tagsobjectfalse
»» [any property]stringfalse
» versionstringfalse

Enumerated Values

PropertyValue
statuspending
statusrunning
statussucceeded
statuscanceling
statuscanceled
statusfailed
statusoffline
statusidle
statusbusy

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