How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coder Builds API

The Builds API from Coder — 9 operation(s) for builds.

Coder Builds API is one of 32 APIs that Coder publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Builds. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 9 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{coderHost}/api/v2.

11 operations 9 paths 47 schemas 8 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://coder.example.com/api/v2
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Coder Builds API declares 1 security scheme for authenticating requests. An API key is passed in the header as Coder-Session-Token (CoderSessionToken). By default, every request must be authenticated.

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 8 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Builds 11
GET
/api/v2/users/{user}/workspace/{workspacename}/builds/{buildnumber}
Get workspace build by user, workspace name, and build number
get-workspace-build-by-user-workspace-name-and-build-number 3 params → 200
GET
/api/v2/workspacebuilds/{workspacebuild}
Get workspace build
get-workspace-build 1 param → 200
PATCH
/api/v2/workspacebuilds/{workspacebuild}/cancel
Cancel workspace build
cancel-workspace-build 2 params → 200
GET
/api/v2/workspacebuilds/{workspacebuild}/logs
Get workspace build logs
get-workspace-build-logs 5 params → 200
GET
/api/v2/workspacebuilds/{workspacebuild}/parameters
Get build parameters for workspace build
get-build-parameters-for-workspace-build 1 param → 200
GET
/api/v2/workspacebuilds/{workspacebuild}/resources
Removed: Get workspace resources for workspace build
removed-get-workspace-resources-for-workspace-build 1 param → 200
GET
/api/v2/workspacebuilds/{workspacebuild}/state
Get provisioner state for workspace build
get-provisioner-state-for-workspace-build 1 param → 200
PUT
/api/v2/workspacebuilds/{workspacebuild}/state
Update workspace build state
update-workspace-build-state 1 param body → 204
GET
/api/v2/workspacebuilds/{workspacebuild}/timings
Get workspace build timings by ID
get-workspace-build-timings-by-id 1 param → 200
GET
/api/v2/workspaces/{workspace}/builds
Get workspace builds by workspace ID
get-workspace-builds-by-workspace-id 5 params → 200
POST
/api/v2/workspaces/{workspace}/builds
Create workspace build
create-workspace-build 1 param body → 200

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are codersdk.WorkspaceAgent (33 properties), codersdk.WorkspaceBuild (25 properties), codersdk.ProvisionerJob (21 properties), codersdk.WorkspaceApp (17 properties). Each schema is shown below with its type and property counts.

codersdk.AgentConnectionTiming
object
5 properties
codersdk.ProvisionerJob
object
21 properties
codersdk.LogLevel
string
codersdk.AgentSubsystem
string
codersdk.WorkspaceAppStatus
object
10 properties
codersdk.LogSource
string
codersdk.ProvisionerJobMetadata
object
8 properties
codersdk.UpdateWorkspaceBuildStateRequest
object
1 property
codersdk.WorkspaceAgentHealth
object
2 properties
codersdk.WorkspaceTransition
string
codersdk.WorkspaceAgentScriptStatus
string
codersdk.TimingStage
string
codersdk.WorkspaceResource
object
11 properties
codersdk.WorkspaceAgentStartupScriptBehavior
string
codersdk.Healthcheck
object
3 properties
codersdk.WorkspaceAgentStatus
string
codersdk.JobErrorCode
string
codersdk.Response
object
3 properties
codersdk.WorkspaceBuildParameter
object
2 properties
codersdk.CreateWorkspaceBuildReason
string
codersdk.ProvisionerLogLevel
string
codersdk.CreateWorkspaceBuildRequest
object
9 properties 1 required
codersdk.WorkspaceAppStatusState
string
codersdk.WorkspaceResourceMetadata
object
3 properties
codersdk.WorkspaceAgentLogSource
object
5 properties
codersdk.AgentScriptTiming
object
8 properties
codersdk.ValidationError
object
2 properties 2 required
codersdk.DisplayApp
string
codersdk.MatchedProvisioners
object
3 properties
codersdk.WorkspaceApp
object
17 properties
codersdk.ProvisionerJobStatus
string
codersdk.WorkspaceBuildTimings
object
3 properties
codersdk.ProvisionerJobType
string
codersdk.WorkspaceAgentLifecycle
string
codersdk.ProvisionerTiming
object
7 properties
codersdk.WorkspaceAppOpenIn
string
codersdk.ProvisionerJobInput
object
3 properties
uuid.NullUUID
object
2 properties
codersdk.WorkspaceAgentScript
object
12 properties
codersdk.WorkspaceAgent
object
33 properties
codersdk.WorkspaceAppHealth
string
codersdk.WorkspaceBuild
object
25 properties
codersdk.BuildReason
string
codersdk.WorkspaceAppSharingLevel
string
codersdk.WorkspaceStatus
string
codersdk.DERPRegion
object
2 properties
codersdk.ProvisionerJobLog
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coder-builds-api-openapi.yml Raw ↑

Other APIs Coder publishes across the network.

Coder Workspaces API
Coder Templates API
Coder Users API
Coder Workspace Agents API
Coder Enterprise API
Coder Agents API
Coder AI Bridge API
Coder AI Providers API
Coder Applications API
Coder Audit API
Coder Authorization API
Coder Chats API
Where this information came from

This is an independent, third-party profile of Coder Builds API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.