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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Coder

Coder Workspaces API

The Workspaces API from Coder — 20 operation(s) for workspaces.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 24 operations across 20 paths, and defines 73 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.

24 operations 20 paths 73 schemas 2 DELETE11 GET2 PATCH3 POST6 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
Contact
API Support
License
AGPL-3.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coder Workspaces 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 24

Across 20 paths, the API surfaces 24 operations — 2 DELETE, 11 GET, 2 PATCH, 3 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 24
GET
/api/experimental/watch-all-workspacebuilds
Watch all workspace builds
watch-all-workspace-builds → 101
POST
/api/v2/organizations/{organization}/members/{user}/workspaces
Create user workspace by organization
create-user-workspace-by-organization 2 params body → 200
GET
/api/v2/organizations/{organization}/members/{user}/workspaces/available-users
Get users available for workspace creation
get-users-available-for-workspace-creation 5 params → 200
GET
/api/v2/users/{user}/workspace/{workspacename}
Get workspace metadata by user and workspace name
get-workspace-metadata-by-user-and-workspace-name 3 params → 200
POST
/api/v2/users/{user}/workspaces
Create user workspace
create-user-workspace 1 param body → 200
GET
/api/v2/workspaces
List workspaces
list-workspaces 3 params → 200
GET
/api/v2/workspaces/{workspace}
Get workspace metadata by ID
get-workspace-metadata-by-id 2 params → 200
PATCH
/api/v2/workspaces/{workspace}
Update workspace metadata by ID
update-workspace-metadata-by-id 1 param body → 204
GET
/api/v2/workspaces/{workspace}/acl
Get workspace ACLs
get-workspace-acls 1 param → 200
DELETE
/api/v2/workspaces/{workspace}/acl
Completely clears the workspace's user and group ACLs.
completely-clears-the-workspaces-user-and-group-acls 1 param → 204
PATCH
/api/v2/workspaces/{workspace}/acl
Update workspace ACL
update-workspace-acl 1 param body → 204
GET
/api/v2/workspaces/{workspace}/agent-connection-watch
Workspace Agent Connection Watch
workspace-agent-connection-watch 1 param → 101
PUT
/api/v2/workspaces/{workspace}/autostart
Update workspace autostart schedule by ID
update-workspace-autostart-schedule-by-id 1 param body → 204
PUT
/api/v2/workspaces/{workspace}/autoupdates
Update workspace automatic updates by ID
update-workspace-automatic-updates-by-id 1 param body → 204
PUT
/api/v2/workspaces/{workspace}/dormant
Update workspace dormancy status by id.
update-workspace-dormancy-status-by-id 1 param body → 200
PUT
/api/v2/workspaces/{workspace}/extend
Extend workspace deadline by ID
extend-workspace-deadline-by-id 1 param body → 200
PUT
/api/v2/workspaces/{workspace}/favorite
Favorite workspace by ID.
favorite-workspace-by-id 1 param → 204
DELETE
/api/v2/workspaces/{workspace}/favorite
Unfavorite workspace by ID.
unfavorite-workspace-by-id 1 param → 204
GET
/api/v2/workspaces/{workspace}/resolve-autostart
Resolve workspace autostart by id.
resolve-workspace-autostart-by-id 1 param → 200
GET
/api/v2/workspaces/{workspace}/timings
Get workspace timings by ID
get-workspace-timings-by-id 1 param → 200
PUT
/api/v2/workspaces/{workspace}/ttl
Update workspace TTL by ID
update-workspace-ttl-by-id 1 param body → 204
POST
/api/v2/workspaces/{workspace}/usage
Post Workspace Usage by ID
post-workspace-usage-by-id 1 param body → 204
GET
/api/v2/workspaces/{workspace}/watch
Watch workspace by ID
watch-workspace-by-id 1 param → 200
GET
/api/v2/workspaces/{workspace}/watch-ws
Watch workspace by ID via WebSockets
watch-workspace-by-id-via-websockets 1 param → 200

Schemas 73

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

workspacesdk.BuildUpdate
object
2 properties
codersdk.ServerSentEventType
string
codersdk.WorkspaceUser
object
5 properties 2 required
codersdk.AgentConnectionTiming
object
5 properties
codersdk.ProvisionerJob
object
21 properties
codersdk.AgentSubsystem
string
codersdk.WorkspaceAppStatus
object
10 properties
codersdk.ProvisionerJobMetadata
object
8 properties
codersdk.UpdateWorkspaceDormancy
object
1 property
workspacesdk.AgentUpdate
object
2 properties
codersdk.ServerSentEvent
object
2 properties
codersdk.WorkspaceAgentHealth
object
2 properties
codersdk.WorkspaceTransition
string
codersdk.WorkspaceAgentScriptStatus
string
codersdk.WorkspaceResource
object
11 properties
codersdk.WorkspaceAgentStartupScriptBehavior
string
codersdk.TimingStage
string
codersdk.Healthcheck
object
3 properties
codersdk.WorkspaceAgentStatus
string
codersdk.UpdateWorkspaceACL
object
2 properties
codersdk.UpdateWorkspaceTTLRequest
object
1 property
codersdk.MinimalUser
object
4 properties 2 required
codersdk.JobErrorCode
string
workspacesdk.WatchError
object
4 properties
codersdk.UpdateWorkspaceAutomaticUpdatesRequest
object
1 property
codersdk.GroupSource
string
codersdk.Response
object
3 properties
codersdk.WorkspaceBuildParameter
object
2 properties
codersdk.WorkspaceGroup
object
12 properties
workspacesdk.WatchErrorCode
integer
codersdk.WorkspaceHealth
object
2 properties
codersdk.WorkspaceACL
object
2 properties
codersdk.WorkspaceAppStatusState
string
codersdk.CreateWorkspaceRequest
object
CreateWorkspaceRequest provides options for creating a new workspace. Only one of TemplateID or TemplateVersionID can be specified, not both. If TemplateID is…
8 properties 1 required
codersdk.WorkspaceResourceMetadata
object
3 properties
codersdk.WorkspaceAgentLogSource
object
5 properties
codersdk.AgentScriptTiming
object
8 properties
codersdk.UsageAppName
string
codersdk.DisplayApp
string
codersdk.ValidationError
object
2 properties 2 required
codersdk.MatchedProvisioners
object
3 properties
codersdk.WorkspaceApp
object
17 properties
codersdk.ResolveAutostartResponse
object
1 property
codersdk.PutExtendWorkspaceRequest
object
1 property 1 required
codersdk.LoginType
string
codersdk.ProvisionerJobStatus
string
codersdk.WorkspaceBuildTimings
object
3 properties
codersdk.ProvisionerJobType
string
workspacesdk.ConnectionWatchEvent
object
3 properties
codersdk.WorkspaceAgentLifecycle
string
codersdk.UpdateWorkspaceAutostartRequest
object
1 property
codersdk.SharedWorkspaceActorType
string
codersdk.SharedWorkspaceActor
object
5 properties
codersdk.WorkspaceAppOpenIn
string
codersdk.ProvisionerTiming
object
7 properties
codersdk.WorkspaceRole
string
codersdk.ProvisionerJobInput
object
3 properties
codersdk.UpdateWorkspaceRequest
object
1 property
uuid.NullUUID
object
2 properties
codersdk.UserStatus
string
codersdk.PostWorkspaceUsageRequest
object
2 properties
codersdk.WorkspaceAgentScript
object
12 properties
codersdk.WorkspaceAgent
object
33 properties
codersdk.WorkspaceAppHealth
string
codersdk.WorkspaceBuild
object
25 properties
codersdk.AutomaticUpdates
string
codersdk.BuildReason
string
codersdk.WorkspaceAppSharingLevel
string
codersdk.WorkspacesResponse
object
2 properties
codersdk.ReducedUser
object
12 properties 4 required
codersdk.WorkspaceStatus
string
codersdk.DERPRegion
object
2 properties
codersdk.Workspace
object
33 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coder-workspaces-api-openapi.yml Raw ↑

Other APIs Coder publishes across the network.

Coder Workspaces API
AE Profile APIs.io
Coder Templates API
AE Profile APIs.io
Coder Users API
AE Profile APIs.io
Coder Workspace Agents API
AE Profile APIs.io
Coder Enterprise API
AE Profile APIs.io
Coder Agents API
AE Profile APIs.io
Coder AI Bridge API
AE Profile APIs.io
Coder AI Providers API
AE Profile APIs.io
Coder Applications API
AE Profile APIs.io
Coder Audit API
AE Profile APIs.io
Coder Authorization API
AE Profile APIs.io
Coder Builds API
AE Profile APIs.io
#Workspaces
← Back to C APIs
API Details
ID
coder:coder-workspaces-api
Base URL
https://coder.example.com/api/v2
Docs
https://coder.com/docs/reference/api
Provider
Coder
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=coder-workspaces-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coder-workspaces-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Coder Workspaces 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.