Builds

Builds

Get workspace build by user, workspace name, and build number

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacename}/builds/{buildnumber} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /users/{user}/workspace/{workspacename}/builds/{buildnumber}

Parameters

Name	In	Type	Required	Description
`user`	path	string	true	User ID, name, or me
`workspacename`	path	string	true	Workspace name
`buildnumber`	path	string(number)	true	Build number

Example responses

{
  "build_number": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "daily_cost": 0,
  "deadline": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
  "initiator_name": "string",
  "job": {
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
  },
  "max_deadline": "2019-08-24T14:15:22Z",
  "reason": "initiator",
  "resources": [
    {
      "agents": [
        {
          "api_version": "string",
          "apps": [
            {
              "command": "string",
              "display_name": "string",
              "external": true,
              "health": "disabled",
              "healthcheck": {
                "interval": 0,
                "threshold": 0,
                "url": "string"
              },
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "sharing_level": "owner",
              "slug": "string",
              "subdomain": true,
              "subdomain_name": "string",
              "url": "string"
            }
          ],
          "architecture": "string",
          "connection_timeout_seconds": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "directory": "string",
          "disconnected_at": "2019-08-24T14:15:22Z",
          "display_apps": ["vscode"],
          "environment_variables": {
            "property1": "string",
            "property2": "string"
          },
          "expanded_directory": "string",
          "first_connected_at": "2019-08-24T14:15:22Z",
          "health": {
            "healthy": false,
            "reason": "agent has lost connection"
          },
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "instance_id": "string",
          "last_connected_at": "2019-08-24T14:15:22Z",
          "latency": {
            "property1": {
              "latency_ms": 0,
              "preferred": true
            },
            "property2": {
              "latency_ms": 0,
              "preferred": true
            }
          },
          "lifecycle_state": "created",
          "log_sources": [
            {
              "created_at": "2019-08-24T14:15:22Z",
              "display_name": "string",
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
            }
          ],
          "logs_length": 0,
          "logs_overflowed": true,
          "name": "string",
          "operating_system": "string",
          "ready_at": "2019-08-24T14:15:22Z",
          "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
          "scripts": [
            {
              "cron": "string",
              "log_path": "string",
              "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
              "run_on_start": true,
              "run_on_stop": true,
              "script": "string",
              "start_blocks_login": true,
              "timeout": 0
            }
          ],
          "started_at": "2019-08-24T14:15:22Z",
          "startup_script_behavior": "blocking",
          "status": "connecting",
          "subsystems": ["envbox"],
          "troubleshooting_url": "string",
          "updated_at": "2019-08-24T14:15:22Z",
          "version": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "daily_cost": 0,
      "hide": true,
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
      "metadata": [
        {
          "key": "string",
          "sensitive": true,
          "value": "string"
        }
      ],
      "name": "string",
      "type": "string",
      "workspace_transition": "start"
    }
  ],
  "status": "pending",
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "template_version_name": "string",
  "transition": "start",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_name": "string",
  "workspace_owner_avatar_url": "string",
  "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
  "workspace_owner_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.WorkspaceBuild

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

Get workspace build

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /workspacebuilds/{workspacebuild}

Parameters

Name	In	Type	Required	Description
`workspacebuild`	path	string	true	Workspace build ID

Example responses

{
  "build_number": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "daily_cost": 0,
  "deadline": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
  "initiator_name": "string",
  "job": {
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
  },
  "max_deadline": "2019-08-24T14:15:22Z",
  "reason": "initiator",
  "resources": [
    {
      "agents": [
        {
          "api_version": "string",
          "apps": [
            {
              "command": "string",
              "display_name": "string",
              "external": true,
              "health": "disabled",
              "healthcheck": {
                "interval": 0,
                "threshold": 0,
                "url": "string"
              },
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "sharing_level": "owner",
              "slug": "string",
              "subdomain": true,
              "subdomain_name": "string",
              "url": "string"
            }
          ],
          "architecture": "string",
          "connection_timeout_seconds": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "directory": "string",
          "disconnected_at": "2019-08-24T14:15:22Z",
          "display_apps": ["vscode"],
          "environment_variables": {
            "property1": "string",
            "property2": "string"
          },
          "expanded_directory": "string",
          "first_connected_at": "2019-08-24T14:15:22Z",
          "health": {
            "healthy": false,
            "reason": "agent has lost connection"
          },
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "instance_id": "string",
          "last_connected_at": "2019-08-24T14:15:22Z",
          "latency": {
            "property1": {
              "latency_ms": 0,
              "preferred": true
            },
            "property2": {
              "latency_ms": 0,
              "preferred": true
            }
          },
          "lifecycle_state": "created",
          "log_sources": [
            {
              "created_at": "2019-08-24T14:15:22Z",
              "display_name": "string",
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
            }
          ],
          "logs_length": 0,
          "logs_overflowed": true,
          "name": "string",
          "operating_system": "string",
          "ready_at": "2019-08-24T14:15:22Z",
          "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
          "scripts": [
            {
              "cron": "string",
              "log_path": "string",
              "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
              "run_on_start": true,
              "run_on_stop": true,
              "script": "string",
              "start_blocks_login": true,
              "timeout": 0
            }
          ],
          "started_at": "2019-08-24T14:15:22Z",
          "startup_script_behavior": "blocking",
          "status": "connecting",
          "subsystems": ["envbox"],
          "troubleshooting_url": "string",
          "updated_at": "2019-08-24T14:15:22Z",
          "version": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "daily_cost": 0,
      "hide": true,
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
      "metadata": [
        {
          "key": "string",
          "sensitive": true,
          "value": "string"
        }
      ],
      "name": "string",
      "type": "string",
      "workspace_transition": "start"
    }
  ],
  "status": "pending",
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "template_version_name": "string",
  "transition": "start",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_name": "string",
  "workspace_owner_avatar_url": "string",
  "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
  "workspace_owner_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.WorkspaceBuild

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

Cancel workspace build

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/cancel \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /workspacebuilds/{workspacebuild}/cancel

Parameters

Name	In	Type	Required	Description
`workspacebuild`	path	string	true	Workspace build ID

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

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

Get workspace build logs

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/logs \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /workspacebuilds/{workspacebuild}/logs

Parameters

Name	In	Type	Required	Description
`workspacebuild`	path	string	true	Workspace build ID
`before`	query	integer	false	Before Unix timestamp
`after`	query	integer	false	After Unix timestamp
`follow`	query	boolean	false	Follow log stream

Example responses

[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": 0,
    "log_level": "trace",
    "log_source": "provisioner_daemon",
    "output": "string",
    "stage": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.ProvisionerJobLog

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» created_at`	string(date-time)	false
`» id`	integer	false
`» log_level`	codersdk.LogLevel	false
`» log_source`	codersdk.LogSource	false
`» output`	string	false
`» stage`	string	false

Enumerated Values

Property	Value
`log_level`	`trace`
`log_level`	`debug`
`log_level`	`info`
`log_level`	`warn`
`log_level`	`error`
`log_source`	`provisioner_daemon`
`log_source`	`provisioner`

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

Get build parameters for workspace build

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/parameters \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /workspacebuilds/{workspacebuild}/parameters

Parameters

Name	In	Type	Required	Description
`workspacebuild`	path	string	true	Workspace build ID

Example responses

[
  {
    "name": "string",
    "value": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.WorkspaceBuildParameter

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» name`	string	false
`» value`	string	false

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

Removed: Get workspace resources for workspace build

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/resources \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /workspacebuilds/{workspacebuild}/resources

Parameters

Name	In	Type	Required	Description
`workspacebuild`	path	string	true	Workspace build ID

Example responses

[
  {
    "agents": [
      {
        "api_version": "string",
        "apps": [
          {
            "command": "string",
            "display_name": "string",
            "external": true,
            "health": "disabled",
            "healthcheck": {
              "interval": 0,
              "threshold": 0,
              "url": "string"
            },
            "icon": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "sharing_level": "owner",
            "slug": "string",
            "subdomain": true,
            "subdomain_name": "string",
            "url": "string"
          }
        ],
        "architecture": "string",
        "connection_timeout_seconds": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "directory": "string",
        "disconnected_at": "2019-08-24T14:15:22Z",
        "display_apps": ["vscode"],
        "environment_variables": {
          "property1": "string",
          "property2": "string"
        },
        "expanded_directory": "string",
        "first_connected_at": "2019-08-24T14:15:22Z",
        "health": {
          "healthy": false,
          "reason": "agent has lost connection"
        },
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "instance_id": "string",
        "last_connected_at": "2019-08-24T14:15:22Z",
        "latency": {
          "property1": {
            "latency_ms": 0,
            "preferred": true
          },
          "property2": {
            "latency_ms": 0,
            "preferred": true
          }
        },
        "lifecycle_state": "created",
        "log_sources": [
          {
            "created_at": "2019-08-24T14:15:22Z",
            "display_name": "string",
            "icon": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
          }
        ],
        "logs_length": 0,
        "logs_overflowed": true,
        "name": "string",
        "operating_system": "string",
        "ready_at": "2019-08-24T14:15:22Z",
        "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
        "scripts": [
          {
            "cron": "string",
            "log_path": "string",
            "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
            "run_on_start": true,
            "run_on_stop": true,
            "script": "string",
            "start_blocks_login": true,
            "timeout": 0
          }
        ],
        "started_at": "2019-08-24T14:15:22Z",
        "startup_script_behavior": "blocking",
        "status": "connecting",
        "subsystems": ["envbox"],
        "troubleshooting_url": "string",
        "updated_at": "2019-08-24T14:15:22Z",
        "version": "string"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "daily_cost": 0,
    "hide": true,
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
    "metadata": [
      {
        "key": "string",
        "sensitive": true,
        "value": "string"
      }
    ],
    "name": "string",
    "type": "string",
    "workspace_transition": "start"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.WorkspaceResource

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» agents`	array	false
`»» api_version`	string	false
`»» apps`	array	false
`»»» command`	string	false
`»»» display_name`	string	false	Display name is a friendly name for the app.
`»»» external`	boolean	false	External specifies whether the URL should be opened externally on the client or not.
`»»» health`	codersdk.WorkspaceAppHealth	false
`»»» healthcheck`	codersdk.Healthcheck	false	Healthcheck specifies the configuration for checking app health.
`»»»» interval`	integer	false	Interval specifies the seconds between each health check.
`»»»» threshold`	integer	false	Threshold specifies the number of consecutive failed health checks before returning "unhealthy".
`»»»» url`	string	false	URL specifies the endpoint to check for the app health.
`»»» icon`	string	false	Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.
`»»» id`	string(uuid)	false
`»»» sharing_level`	codersdk.WorkspaceAppSharingLevel	false
`»»» slug`	string	false	Slug is a unique identifier within the agent.
`»»» subdomain`	boolean	false	Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.
`»»» subdomain_name`	string	false	Subdomain name is the application domain exposed on the `coder server`.
`»»» url`	string	false	URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.
`»» architecture`	string	false
`»» connection_timeout_seconds`	integer	false
`»» created_at`	string(date-time)	false
`»» directory`	string	false
`»» disconnected_at`	string(date-time)	false
`»» display_apps`	array	false
`»» environment_variables`	object	false
`»»» [any property]`	string	false
`»» expanded_directory`	string	false
`»» first_connected_at`	string(date-time)	false
`»» health`	codersdk.WorkspaceAgentHealth	false	Health reports the health of the agent.
`»»» healthy`	boolean	false	Healthy is true if the agent is healthy.
`»»» reason`	string	false	Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.
`»» id`	string(uuid)	false
`»» instance_id`	string	false
`»» last_connected_at`	string(date-time)	false
`»» latency`	object	false	Latency is mapped by region name (e.g. "New York City", "Seattle").
`»»» [any property]`	codersdk.DERPRegion	false
`»»»» latency_ms`	number	false
`»»»» preferred`	boolean	false
`»» lifecycle_state`	codersdk.WorkspaceAgentLifecycle	false
`»» log_sources`	array	false
`»»» created_at`	string(date-time)	false
`»»» display_name`	string	false
`»»» icon`	string	false
`»»» id`	string(uuid)	false
`»»» workspace_agent_id`	string(uuid)	false
`»» logs_length`	integer	false
`»» logs_overflowed`	boolean	false
`»» name`	string	false
`»» operating_system`	string	false
`»» ready_at`	string(date-time)	false
`»» resource_id`	string(uuid)	false
`»» scripts`	array	false
`»»» cron`	string	false
`»»» log_path`	string	false
`»»» log_source_id`	string(uuid)	false
`»»» run_on_start`	boolean	false
`»»» run_on_stop`	boolean	false
`»»» script`	string	false
`»»» start_blocks_login`	boolean	false
`»»» timeout`	integer	false
`»» started_at`	string(date-time)	false
`»» startup_script_behavior`	codersdk.WorkspaceAgentStartupScriptBehavior	false	Startup script behavior is a legacy field that is deprecated in favor of the `coder_script` resource. It's only referenced by old clients. Deprecated: Remove in the future!
`»» status`	codersdk.WorkspaceAgentStatus	false
`»» subsystems`	array	false
`»» troubleshooting_url`	string	false
`»» updated_at`	string(date-time)	false
`»» version`	string	false
`» created_at`	string(date-time)	false
`» daily_cost`	integer	false
`» hide`	boolean	false
`» icon`	string	false
`» id`	string(uuid)	false
`» job_id`	string(uuid)	false
`» metadata`	array	false
`»» key`	string	false
`»» sensitive`	boolean	false
`»» value`	string	false
`» name`	string	false
`» type`	string	false
`» workspace_transition`	codersdk.WorkspaceTransition	false

Enumerated Values

Property	Value
`health`	`disabled`
`health`	`initializing`
`health`	`healthy`
`health`	`unhealthy`
`sharing_level`	`owner`
`sharing_level`	`authenticated`
`sharing_level`	`public`
`lifecycle_state`	`created`
`lifecycle_state`	`starting`
`lifecycle_state`	`start_timeout`
`lifecycle_state`	`start_error`
`lifecycle_state`	`ready`
`lifecycle_state`	`shutting_down`
`lifecycle_state`	`shutdown_timeout`
`lifecycle_state`	`shutdown_error`
`lifecycle_state`	`off`
`startup_script_behavior`	`blocking`
`startup_script_behavior`	`non-blocking`
`status`	`connecting`
`status`	`connected`
`status`	`disconnected`
`status`	`timeout`
`workspace_transition`	`start`
`workspace_transition`	`stop`
`workspace_transition`	`delete`

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

Get provisioner state for workspace build

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/state \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /workspacebuilds/{workspacebuild}/state

Parameters

Name	In	Type	Required	Description
`workspacebuild`	path	string	true	Workspace build ID

Example responses

{
  "build_number": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "daily_cost": 0,
  "deadline": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
  "initiator_name": "string",
  "job": {
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
  },
  "max_deadline": "2019-08-24T14:15:22Z",
  "reason": "initiator",
  "resources": [
    {
      "agents": [
        {
          "api_version": "string",
          "apps": [
            {
              "command": "string",
              "display_name": "string",
              "external": true,
              "health": "disabled",
              "healthcheck": {
                "interval": 0,
                "threshold": 0,
                "url": "string"
              },
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "sharing_level": "owner",
              "slug": "string",
              "subdomain": true,
              "subdomain_name": "string",
              "url": "string"
            }
          ],
          "architecture": "string",
          "connection_timeout_seconds": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "directory": "string",
          "disconnected_at": "2019-08-24T14:15:22Z",
          "display_apps": ["vscode"],
          "environment_variables": {
            "property1": "string",
            "property2": "string"
          },
          "expanded_directory": "string",
          "first_connected_at": "2019-08-24T14:15:22Z",
          "health": {
            "healthy": false,
            "reason": "agent has lost connection"
          },
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "instance_id": "string",
          "last_connected_at": "2019-08-24T14:15:22Z",
          "latency": {
            "property1": {
              "latency_ms": 0,
              "preferred": true
            },
            "property2": {
              "latency_ms": 0,
              "preferred": true
            }
          },
          "lifecycle_state": "created",
          "log_sources": [
            {
              "created_at": "2019-08-24T14:15:22Z",
              "display_name": "string",
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
            }
          ],
          "logs_length": 0,
          "logs_overflowed": true,
          "name": "string",
          "operating_system": "string",
          "ready_at": "2019-08-24T14:15:22Z",
          "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
          "scripts": [
            {
              "cron": "string",
              "log_path": "string",
              "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
              "run_on_start": true,
              "run_on_stop": true,
              "script": "string",
              "start_blocks_login": true,
              "timeout": 0
            }
          ],
          "started_at": "2019-08-24T14:15:22Z",
          "startup_script_behavior": "blocking",
          "status": "connecting",
          "subsystems": ["envbox"],
          "troubleshooting_url": "string",
          "updated_at": "2019-08-24T14:15:22Z",
          "version": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "daily_cost": 0,
      "hide": true,
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
      "metadata": [
        {
          "key": "string",
          "sensitive": true,
          "value": "string"
        }
      ],
      "name": "string",
      "type": "string",
      "workspace_transition": "start"
    }
  ],
  "status": "pending",
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "template_version_name": "string",
  "transition": "start",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_name": "string",
  "workspace_owner_avatar_url": "string",
  "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
  "workspace_owner_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.WorkspaceBuild

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

Get workspace builds by workspace ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /workspaces/{workspace}/builds

Parameters

Name	In	Type	Required	Description
`workspace`	path	string(uuid)	true	Workspace ID
`after_id`	query	string(uuid)	false	After ID
`limit`	query	integer	false	Page limit
`offset`	query	integer	false	Page offset
`since`	query	string(date-time)	false	Since timestamp

Example responses

[
  {
    "build_number": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "daily_cost": 0,
    "deadline": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
    "initiator_name": "string",
    "job": {
      "canceled_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "error": "string",
      "error_code": "REQUIRED_TEMPLATE_VARIABLES",
      "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "queue_position": 0,
      "queue_size": 0,
      "started_at": "2019-08-24T14:15:22Z",
      "status": "pending",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
    },
    "max_deadline": "2019-08-24T14:15:22Z",
    "reason": "initiator",
    "resources": [
      {
        "agents": [
          {
            "api_version": "string",
            "apps": [
              {
                "command": "string",
                "display_name": "string",
                "external": true,
                "health": "disabled",
                "healthcheck": {
                  "interval": 0,
                  "threshold": 0,
                  "url": "string"
                },
                "icon": "string",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "sharing_level": "owner",
                "slug": "string",
                "subdomain": true,
                "subdomain_name": "string",
                "url": "string"
              }
            ],
            "architecture": "string",
            "connection_timeout_seconds": 0,
            "created_at": "2019-08-24T14:15:22Z",
            "directory": "string",
            "disconnected_at": "2019-08-24T14:15:22Z",
            "display_apps": ["vscode"],
            "environment_variables": {
              "property1": "string",
              "property2": "string"
            },
            "expanded_directory": "string",
            "first_connected_at": "2019-08-24T14:15:22Z",
            "health": {
              "healthy": false,
              "reason": "agent has lost connection"
            },
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "instance_id": "string",
            "last_connected_at": "2019-08-24T14:15:22Z",
            "latency": {
              "property1": {
                "latency_ms": 0,
                "preferred": true
              },
              "property2": {
                "latency_ms": 0,
                "preferred": true
              }
            },
            "lifecycle_state": "created",
            "log_sources": [
              {
                "created_at": "2019-08-24T14:15:22Z",
                "display_name": "string",
                "icon": "string",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
              }
            ],
            "logs_length": 0,
            "logs_overflowed": true,
            "name": "string",
            "operating_system": "string",
            "ready_at": "2019-08-24T14:15:22Z",
            "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
            "scripts": [
              {
                "cron": "string",
                "log_path": "string",
                "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
                "run_on_start": true,
                "run_on_stop": true,
                "script": "string",
                "start_blocks_login": true,
                "timeout": 0
              }
            ],
            "started_at": "2019-08-24T14:15:22Z",
            "startup_script_behavior": "blocking",
            "status": "connecting",
            "subsystems": ["envbox"],
            "troubleshooting_url": "string",
            "updated_at": "2019-08-24T14:15:22Z",
            "version": "string"
          }
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "daily_cost": 0,
        "hide": true,
        "icon": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
        "metadata": [
          {
            "key": "string",
            "sensitive": true,
            "value": "string"
          }
        ],
        "name": "string",
        "type": "string",
        "workspace_transition": "start"
      }
    ],
    "status": "pending",
    "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
    "template_version_name": "string",
    "transition": "start",
    "updated_at": "2019-08-24T14:15:22Z",
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "workspace_name": "string",
    "workspace_owner_avatar_url": "string",
    "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
    "workspace_owner_name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.WorkspaceBuild

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» build_number`	integer	false
`» created_at`	string(date-time)	false
`» daily_cost`	integer	false
`» deadline`	string(date-time)	false
`» id`	string(uuid)	false
`» initiator_id`	string(uuid)	false
`» initiator_name`	string	false
`» job`	codersdk.ProvisionerJob	false
`»» canceled_at`	string(date-time)	false
`»» completed_at`	string(date-time)	false
`»» created_at`	string(date-time)	false
`»» error`	string	false
`»» error_code`	codersdk.JobErrorCode	false
`»» file_id`	string(uuid)	false
`»» id`	string(uuid)	false
`»» queue_position`	integer	false
`»» queue_size`	integer	false
`»» started_at`	string(date-time)	false
`»» status`	codersdk.ProvisionerJobStatus	false
`»» tags`	object	false
`»»» [any property]`	string	false
`»» worker_id`	string(uuid)	false
`» max_deadline`	string(date-time)	false
`» reason`	codersdk.BuildReason	false
`» resources`	array	false
`»» agents`	array	false
`»»» api_version`	string	false
`»»» apps`	array	false
`»»»» command`	string	false
`»»»» display_name`	string	false	Display name is a friendly name for the app.
`»»»» external`	boolean	false	External specifies whether the URL should be opened externally on the client or not.
`»»»» health`	codersdk.WorkspaceAppHealth	false
`»»»» healthcheck`	codersdk.Healthcheck	false	Healthcheck specifies the configuration for checking app health.
`»»»»» interval`	integer	false	Interval specifies the seconds between each health check.
`»»»»» threshold`	integer	false	Threshold specifies the number of consecutive failed health checks before returning "unhealthy".
`»»»»» url`	string	false	URL specifies the endpoint to check for the app health.
`»»»» icon`	string	false	Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.
`»»»» id`	string(uuid)	false
`»»»» sharing_level`	codersdk.WorkspaceAppSharingLevel	false
`»»»» slug`	string	false	Slug is a unique identifier within the agent.
`»»»» subdomain`	boolean	false	Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.
`»»»» subdomain_name`	string	false	Subdomain name is the application domain exposed on the `coder server`.
`»»»» url`	string	false	URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.
`»»» architecture`	string	false
`»»» connection_timeout_seconds`	integer	false
`»»» created_at`	string(date-time)	false
`»»» directory`	string	false
`»»» disconnected_at`	string(date-time)	false
`»»» display_apps`	array	false
`»»» environment_variables`	object	false
`»»»» [any property]`	string	false
`»»» expanded_directory`	string	false
`»»» first_connected_at`	string(date-time)	false
`»»» health`	codersdk.WorkspaceAgentHealth	false	Health reports the health of the agent.
`»»»» healthy`	boolean	false	Healthy is true if the agent is healthy.
`»»»» reason`	string	false	Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.
`»»» id`	string(uuid)	false
`»»» instance_id`	string	false
`»»» last_connected_at`	string(date-time)	false
`»»» latency`	object	false	Latency is mapped by region name (e.g. "New York City", "Seattle").
`»»»» [any property]`	codersdk.DERPRegion	false
`»»»»» latency_ms`	number	false
`»»»»» preferred`	boolean	false
`»»» lifecycle_state`	codersdk.WorkspaceAgentLifecycle	false
`»»» log_sources`	array	false
`»»»» created_at`	string(date-time)	false
`»»»» display_name`	string	false
`»»»» icon`	string	false
`»»»» id`	string(uuid)	false
`»»»» workspace_agent_id`	string(uuid)	false
`»»» logs_length`	integer	false
`»»» logs_overflowed`	boolean	false
`»»» name`	string	false
`»»» operating_system`	string	false
`»»» ready_at`	string(date-time)	false
`»»» resource_id`	string(uuid)	false
`»»» scripts`	array	false
`»»»» cron`	string	false
`»»»» log_path`	string	false
`»»»» log_source_id`	string(uuid)	false
`»»»» run_on_start`	boolean	false
`»»»» run_on_stop`	boolean	false
`»»»» script`	string	false
`»»»» start_blocks_login`	boolean	false
`»»»» timeout`	integer	false
`»»» started_at`	string(date-time)	false
`»»» startup_script_behavior`	codersdk.WorkspaceAgentStartupScriptBehavior	false	Startup script behavior is a legacy field that is deprecated in favor of the `coder_script` resource. It's only referenced by old clients. Deprecated: Remove in the future!
`»»» status`	codersdk.WorkspaceAgentStatus	false
`»»» subsystems`	array	false
`»»» troubleshooting_url`	string	false
`»»» updated_at`	string(date-time)	false
`»»» version`	string	false
`»» created_at`	string(date-time)	false
`»» daily_cost`	integer	false
`»» hide`	boolean	false
`»» icon`	string	false
`»» id`	string(uuid)	false
`»» job_id`	string(uuid)	false
`»» metadata`	array	false
`»»» key`	string	false
`»»» sensitive`	boolean	false
`»»» value`	string	false
`»» name`	string	false
`»» type`	string	false
`»» workspace_transition`	codersdk.WorkspaceTransition	false
`» status`	codersdk.WorkspaceStatus	false
`» template_version_id`	string(uuid)	false
`» template_version_name`	string	false
`» transition`	codersdk.WorkspaceTransition	false
`» updated_at`	string(date-time)	false
`» workspace_id`	string(uuid)	false
`» workspace_name`	string	false
`» workspace_owner_avatar_url`	string	false
`» workspace_owner_id`	string(uuid)	false
`» workspace_owner_name`	string	false

Enumerated Values

Property	Value
`error_code`	`REQUIRED_TEMPLATE_VARIABLES`
`status`	`pending`
`status`	`running`
`status`	`succeeded`
`status`	`canceling`
`status`	`canceled`
`status`	`failed`
`reason`	`initiator`
`reason`	`autostart`
`reason`	`autostop`
`health`	`disabled`
`health`	`initializing`
`health`	`healthy`
`health`	`unhealthy`
`sharing_level`	`owner`
`sharing_level`	`authenticated`
`sharing_level`	`public`
`lifecycle_state`	`created`
`lifecycle_state`	`starting`
`lifecycle_state`	`start_timeout`
`lifecycle_state`	`start_error`
`lifecycle_state`	`ready`
`lifecycle_state`	`shutting_down`
`lifecycle_state`	`shutdown_timeout`
`lifecycle_state`	`shutdown_error`
`lifecycle_state`	`off`
`startup_script_behavior`	`blocking`
`startup_script_behavior`	`non-blocking`
`status`	`connecting`
`status`	`connected`
`status`	`disconnected`
`status`	`timeout`
`workspace_transition`	`start`
`workspace_transition`	`stop`
`workspace_transition`	`delete`
`status`	`pending`
`status`	`starting`
`status`	`running`
`status`	`stopping`
`status`	`stopped`
`status`	`failed`
`status`	`canceling`
`status`	`canceled`
`status`	`deleting`
`status`	`deleted`
`transition`	`start`
`transition`	`stop`
`transition`	`delete`

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

Create workspace build

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /workspaces/{workspace}/builds

{
  "dry_run": true,
  "log_level": "debug",
  "orphan": true,
  "rich_parameter_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "state": [0],
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "transition": "create"
}

Parameters

Name	In	Type	Required	Description
`workspace`	path	string(uuid)	true	Workspace ID
`body`	body	codersdk.CreateWorkspaceBuildRequest	true	Create workspace build request

Example responses

{
  "build_number": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "daily_cost": 0,
  "deadline": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
  "initiator_name": "string",
  "job": {
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
  },
  "max_deadline": "2019-08-24T14:15:22Z",
  "reason": "initiator",
  "resources": [
    {
      "agents": [
        {
          "api_version": "string",
          "apps": [
            {
              "command": "string",
              "display_name": "string",
              "external": true,
              "health": "disabled",
              "healthcheck": {
                "interval": 0,
                "threshold": 0,
                "url": "string"
              },
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "sharing_level": "owner",
              "slug": "string",
              "subdomain": true,
              "subdomain_name": "string",
              "url": "string"
            }
          ],
          "architecture": "string",
          "connection_timeout_seconds": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "directory": "string",
          "disconnected_at": "2019-08-24T14:15:22Z",
          "display_apps": ["vscode"],
          "environment_variables": {
            "property1": "string",
            "property2": "string"
          },
          "expanded_directory": "string",
          "first_connected_at": "2019-08-24T14:15:22Z",
          "health": {
            "healthy": false,
            "reason": "agent has lost connection"
          },
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "instance_id": "string",
          "last_connected_at": "2019-08-24T14:15:22Z",
          "latency": {
            "property1": {
              "latency_ms": 0,
              "preferred": true
            },
            "property2": {
              "latency_ms": 0,
              "preferred": true
            }
          },
          "lifecycle_state": "created",
          "log_sources": [
            {
              "created_at": "2019-08-24T14:15:22Z",
              "display_name": "string",
              "icon": "string",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
            }
          ],
          "logs_length": 0,
          "logs_overflowed": true,
          "name": "string",
          "operating_system": "string",
          "ready_at": "2019-08-24T14:15:22Z",
          "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
          "scripts": [
            {
              "cron": "string",
              "log_path": "string",
              "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
              "run_on_start": true,
              "run_on_stop": true,
              "script": "string",
              "start_blocks_login": true,
              "timeout": 0
            }
          ],
          "started_at": "2019-08-24T14:15:22Z",
          "startup_script_behavior": "blocking",
          "status": "connecting",
          "subsystems": ["envbox"],
          "troubleshooting_url": "string",
          "updated_at": "2019-08-24T14:15:22Z",
          "version": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "daily_cost": 0,
      "hide": true,
      "icon": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
      "metadata": [
        {
          "key": "string",
          "sensitive": true,
          "value": "string"
        }
      ],
      "name": "string",
      "type": "string",
      "workspace_transition": "start"
    }
  ],
  "status": "pending",
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "template_version_name": "string",
  "transition": "start",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_name": "string",
  "workspace_owner_avatar_url": "string",
  "workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
  "workspace_owner_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.WorkspaceBuild

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

See an opportunity to improve our docs? Make an edit.

On this page

Boost Developer Productivity & Streamline Onboarding with CDE's

Get workspace build by user, workspace name, and build number

Code samples

Parameters

Example responses

Responses

Get workspace build

Code samples

Parameters

Example responses

Responses

Cancel workspace build

Code samples

Parameters

Example responses

Responses

Get workspace build logs

Code samples

Parameters

Example responses

Responses

Response Schema

Enumerated Values

Get build parameters for workspace build

Code samples

Parameters

Example responses

Responses

Response Schema

Removed: Get workspace resources for workspace build

Code samples

Parameters

Example responses

Responses

Response Schema

Enumerated Values

Get provisioner state for workspace build

Code samples

Parameters

Example responses

Responses

Get workspace builds by workspace ID

Code samples

Parameters

Example responses

Responses

Response Schema

Enumerated Values

Create workspace build

Code samples

Parameters

Example responses

Responses