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 Agents API

The Agents API from Coder — 28 operation(s) for agents.

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

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

This API exposes 28 operations across 28 paths, and defines 50 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.

28 operations 28 paths 50 schemas 1 DELETE20 GET2 PATCH5 POST

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 Agents 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 28

Across 28 paths, the API surfaces 28 operations — 1 DELETE, 20 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Agents 28
GET
/api/v2/debug/{user}/debug-link
Debug OIDC context for a user
debug-oidc-context-for-a-user 1 param → 200
GET
/api/v2/derp-map
Get DERP map updates
get-derp-map-updates → 101
GET
/api/v2/tailnet
User-scoped tailnet RPC connection
user-scoped-tailnet-rpc-connection → 101
POST
/api/v2/workspaceagents/aws-instance-identity
Authenticate agent on AWS instance
authenticate-agent-on-aws-instance body → 200
POST
/api/v2/workspaceagents/azure-instance-identity
Authenticate agent on Azure instance
authenticate-agent-on-azure-instance body → 200
GET
/api/v2/workspaceagents/connection
Get connection info for workspace agent generic
get-connection-info-for-workspace-agent-generic → 200
POST
/api/v2/workspaceagents/google-instance-identity
Authenticate agent on Google Cloud instance
authenticate-agent-on-google-cloud-instance body → 200
PATCH
/api/v2/workspaceagents/me/app-status
Patch workspace agent app status
patch-workspace-agent-app-status body → 200
GET
/api/v2/workspaceagents/me/external-auth
Get workspace agent external auth
get-workspace-agent-external-auth 3 params → 200
GET
/api/v2/workspaceagents/me/gitauth
Removed: Get workspace agent git auth
removed-get-workspace-agent-git-auth 3 params → 200
GET
/api/v2/workspaceagents/me/gitsshkey
Get workspace agent Git SSH key
get-workspace-agent-git-ssh-key → 200
POST
/api/v2/workspaceagents/me/log-source
Post workspace agent log source
post-workspace-agent-log-source body → 200
PATCH
/api/v2/workspaceagents/me/logs
Patch workspace agent logs
patch-workspace-agent-logs body → 200
GET
/api/v2/workspaceagents/me/reinit
Get workspace agent reinitialization
get-workspace-agent-reinitialization 1 param → 200409
GET
/api/v2/workspaceagents/me/rpc
Workspace agent RPC API
workspace-agent-rpc-api → 101
GET
/api/v2/workspaceagents/{workspaceagent}
Get workspace agent by ID
get-workspace-agent-by-id 1 param → 200
GET
/api/v2/workspaceagents/{workspaceagent}/connection
Get connection info for workspace agent
get-connection-info-for-workspace-agent 1 param → 200
GET
/api/v2/workspaceagents/{workspaceagent}/containers
Get running containers for workspace agent
get-running-containers-for-workspace-agent 2 params → 200
DELETE
/api/v2/workspaceagents/{workspaceagent}/containers/devcontainers/{devcontainer}
Delete devcontainer for workspace agent
delete-devcontainer-for-workspace-agent 2 params → 204
POST
/api/v2/workspaceagents/{workspaceagent}/containers/devcontainers/{devcontainer}/recreate
Recreate devcontainer for workspace agent
recreate-devcontainer-for-workspace-agent 2 params → 202
GET
/api/v2/workspaceagents/{workspaceagent}/containers/watch
Watch workspace agent for container updates.
watch-workspace-agent-for-container-updates 1 param → 200
GET
/api/v2/workspaceagents/{workspaceagent}/coordinate
Coordinate workspace agent
coordinate-workspace-agent 1 param → 101
GET
/api/v2/workspaceagents/{workspaceagent}/listening-ports
Get listening ports for workspace agent
get-listening-ports-for-workspace-agent 1 param → 200
GET
/api/v2/workspaceagents/{workspaceagent}/logs
Get logs by workspace agent
get-logs-by-workspace-agent 6 params → 200
GET
/api/v2/workspaceagents/{workspaceagent}/pty
Open PTY to workspace agent
open-pty-to-workspace-agent 1 param → 101
GET
/api/v2/workspaceagents/{workspaceagent}/startup-logs
Removed: Get logs by workspace agent
removed-get-logs-by-workspace-agent 5 params → 200
GET
/api/v2/workspaceagents/{workspaceagent}/watch-metadata
Watch for workspace agent metadata updates
watch-for-workspace-agent-metadata-updates 1 param → 200
GET
/api/v2/workspaceagents/{workspaceagent}/watch-metadata-ws
Watch for workspace agent metadata updates via WebSockets
watch-for-workspace-agent-metadata-updates-via-websockets 1 param → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are codersdk.WorkspaceAgent (33 properties), codersdk.WorkspaceApp (17 properties), tailcfg.DERPNode (13 properties), codersdk.WorkspaceAgentScript (12 properties). Each schema is shown below with its type and property counts.

agentsdk.PostLogSourceRequest
object
3 properties
codersdk.ServerSentEventType
string
tailcfg.DERPMap
object
3 properties
agentsdk.ExternalAuthResponse
object
6 properties
codersdk.LogLevel
string
codersdk.AgentSubsystem
string
codersdk.WorkspaceAppStatus
object
10 properties
agentsdk.ReinitializationReason
string
tailcfg.DERPRegion
object
6 properties
codersdk.ServerSentEvent
object
2 properties
codersdk.WorkspaceAgentHealth
object
2 properties
agentsdk.Log
object
3 properties
codersdk.WorkspaceAgentScriptStatus
string
codersdk.WorkspaceAgentStartupScriptBehavior
string
codersdk.Healthcheck
object
3 properties
codersdk.WorkspaceAgentStatus
string
codersdk.WorkspaceAgentListContainersResponse
object
3 properties
codersdk.WorkspaceAgentDevcontainer
object
10 properties
workspacesdk.AgentConnectionInfo
object
4 properties
tailcfg.DERPHomeParams
object
1 property
codersdk.WorkspaceAgentDevcontainerStatus
string
agentsdk.GitSSHKey
object
2 properties
agentsdk.PatchAppStatus
object
6 properties
codersdk.Response
object
3 properties
codersdk.WorkspaceAppStatusState
string
codersdk.WorkspaceAgentListeningPortsResponse
object
1 property
agentsdk.GoogleInstanceIdentityToken
object
2 properties 1 required
codersdk.WorkspaceAgentLogSource
object
5 properties
codersdk.WorkspaceAgentListeningPort
object
3 properties
codersdk.ValidationError
object
2 properties 2 required
codersdk.DisplayApp
string
codersdk.WorkspaceAgentLog
object
5 properties
codersdk.WorkspaceApp
object
17 properties
codersdk.WorkspaceAgentContainerPort
object
4 properties
tailcfg.DERPNode
object
13 properties
codersdk.WorkspaceAgentLifecycle
string
agentsdk.PatchLogs
object
2 properties
codersdk.WorkspaceAppOpenIn
string
codersdk.WorkspaceAgentDevcontainerAgent
object
3 properties
agentsdk.AWSInstanceIdentityToken
object
3 properties 2 required
uuid.NullUUID
object
2 properties
codersdk.WorkspaceAgentContainer
object
9 properties
codersdk.WorkspaceAgentScript
object
12 properties
agentsdk.ReinitializationEvent
object
3 properties
codersdk.WorkspaceAgent
object
33 properties
codersdk.WorkspaceAppHealth
string
agentsdk.AuthenticateResponse
object
1 property
agentsdk.AzureInstanceIdentityToken
object
3 properties 2 required
codersdk.WorkspaceAppSharingLevel
string
codersdk.DERPRegion
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coder-agents-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 AI Bridge API
Coder AI Providers API
Coder Applications API
Coder Audit API
Coder Authorization API
Coder Builds API
Coder Chats API
Where this information came from

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