2026-08-11 11:22:55 -04:00
---
# Code generated by make gen. DO NOT EDIT.
title : Agents
description : "REST endpoints for the workspace agent daemon (`coder_agent`)."
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
2023-01-05 15:27:10 +01:00
2026-06-22 07:43:13 +00:00
Workspace agent endpoints. These power the workspace agent daemon defined by the `coder_agent` Terraform resource. This API is NOT the Coder Agents Chats API. For programmatic access to AI Coder Agents, see the Chats API.
2023-07-26 09:21:04 -07:00
## Get DERP map updates
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-07-26 09:21:04 -07:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/derp-map \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/derp-map`
2023-07-26 09:21:04 -07:00
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|--------------------------------------------------------------------------|---------------------|--------|
2023-07-26 09:21:04 -07:00
| 101 | [Switching Protocols ](https://tools.ietf.org/html/rfc7231#section-6.2.2 ) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2024-11-01 14:53:53 +11:00
## User-scoped tailnet RPC connection
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2024-11-01 14:53:53 +11:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/tailnet \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/tailnet`
2024-11-01 14:53:53 +11:00
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|--------------------------------------------------------------------------|---------------------|--------|
2024-11-01 14:53:53 +11:00
| 101 | [Switching Protocols ](https://tools.ietf.org/html/rfc7231#section-6.2.2 ) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-07-26 09:21:04 -07:00
2023-01-05 15:27:10 +01:00
## Authenticate agent on AWS instance
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-05 15:27:10 +01:00
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/aws-instance-identity \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`POST /api/v2/workspaceagents/aws-instance-identity`
2023-01-05 15:27:10 +01:00
> Body parameter
```json
{
2026-04-16 13:59:09 +02:00
"agent_name" : "string" ,
2025-01-03 18:12:59 +05:00
"document" : "string" ,
"signature" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Parameters
2026-04-16 13:59:09 +02:00
| Name | In | Type | Required | Description |
|--------|------|----------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------|
| `body` | body | [agentsdk.AWSInstanceIdentityToken ](schemas.md#agentsdkawsinstanceidentitytoken ) | true | Instance identity token. The optional agent_name field disambiguates when multiple agents share the same instance ID. |
2023-01-05 15:27:10 +01:00
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"session_token" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Responses
2023-01-29 15:47:24 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
2023-01-29 15:47:24 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [agentsdk.AuthenticateResponse ](schemas.md#agentsdkauthenticateresponse ) |
2023-01-05 15:27:10 +01:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
## Authenticate agent on Azure instance
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-05 15:27:10 +01:00
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/azure-instance-identity \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`POST /api/v2/workspaceagents/azure-instance-identity`
2023-01-05 15:27:10 +01:00
> Body parameter
```json
{
2026-04-16 13:59:09 +02:00
"agent_name" : "string" ,
2025-01-03 18:12:59 +05:00
"encoding" : "string" ,
"signature" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Parameters
2026-04-16 13:59:09 +02:00
| Name | In | Type | Required | Description |
|--------|------|--------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------|
| `body` | body | [agentsdk.AzureInstanceIdentityToken ](schemas.md#agentsdkazureinstanceidentitytoken ) | true | Instance identity token. The optional agent_name field disambiguates when multiple agents share the same instance ID. |
2023-01-05 15:27:10 +01:00
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"session_token" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Responses
2023-01-29 15:47:24 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
2023-01-29 15:47:24 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [agentsdk.AuthenticateResponse ](schemas.md#agentsdkauthenticateresponse ) |
2023-01-05 15:27:10 +01:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
## Authenticate agent on Google Cloud instance
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-05 15:27:10 +01:00
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/google-instance-identity \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`POST /api/v2/workspaceagents/google-instance-identity`
2023-01-05 15:27:10 +01:00
> Body parameter
```json
{
2026-04-16 13:59:09 +02:00
"agent_name" : "string" ,
2025-01-03 18:12:59 +05:00
"json_web_token" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Parameters
2026-04-16 13:59:09 +02:00
| Name | In | Type | Required | Description |
|--------|------|----------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------|
| `body` | body | [agentsdk.GoogleInstanceIdentityToken ](schemas.md#agentsdkgoogleinstanceidentitytoken ) | true | Instance identity token. The optional agent_name field disambiguates when multiple agents share the same instance ID. |
2023-01-05 15:27:10 +01:00
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"session_token" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Responses
2023-01-29 15:47:24 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
2023-01-29 15:47:24 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [agentsdk.AuthenticateResponse ](schemas.md#agentsdkauthenticateresponse ) |
2023-01-05 15:27:10 +01:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2025-03-31 10:55:44 -04:00
## Patch workspace agent app status
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2025-03-31 10:55:44 -04:00
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/app-status \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`PATCH /api/v2/workspaceagents/me/app-status`
2025-03-31 10:55:44 -04:00
> Body parameter
```json
{
"app_slug" : "string" ,
"icon" : "string" ,
"message" : "string" ,
"needs_user_attention" : true ,
"state" : "working" ,
"uri" : "string"
}
```
### Parameters
| Name | In | Type | Required | Description |
|--------|------|--------------------------------------------------------------|----------|-------------|
| `body` | body | [agentsdk.PatchAppStatus ](schemas.md#agentsdkpatchappstatus ) | true | app status |
### Example responses
> 200 Response
```json
{
"detail" : "string" ,
"message" : "string" ,
"validations" : [
{
"detail" : "string" ,
"field" : "string"
}
]
}
```
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [codersdk.Response ](schemas.md#codersdkresponse ) |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-10-09 18:04:35 -05:00
## Get workspace agent external auth
2023-01-05 15:27:10 +01:00
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-05 15:27:10 +01:00
# Example request using curl
2023-10-09 18:04:35 -05:00
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/external-auth?match= string& id = string \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/me/external-auth`
2023-10-09 18:04:35 -05:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------|-------|---------|----------|-----------------------------------|
2023-10-09 18:04:35 -05:00
| `match` | query | string | true | Match |
| `id` | query | string | true | Provider ID |
| `listen` | query | boolean | false | Wait for a new token to be issued |
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"access_token" : "string" ,
2026-07-07 12:38:37 -07:00
"expires_at" : "string" ,
2025-01-03 18:12:59 +05:00
"password" : "string" ,
"token_extra" : {},
"type" : "string" ,
"url" : "string" ,
"username" : "string"
2023-10-09 18:04:35 -05:00
}
```
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
2023-10-09 18:04:35 -05:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [agentsdk.ExternalAuthResponse ](schemas.md#agentsdkexternalauthresponse ) |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
## Removed: Get workspace agent git auth
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-10-09 18:04:35 -05:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitauth?match= string& id = string \
2023-01-05 15:27:10 +01:00
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/me/gitauth`
2023-01-05 15:27:10 +01:00
### Parameters
2023-10-09 18:04:35 -05:00
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|----------|-------|---------|----------|-----------------------------------|
2023-10-09 18:04:35 -05:00
| `match` | query | string | true | Match |
| `id` | query | string | true | Provider ID |
| `listen` | query | boolean | false | Wait for a new token to be issued |
2023-01-05 15:27:10 +01:00
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"access_token" : "string" ,
2026-07-07 12:38:37 -07:00
"expires_at" : "string" ,
2025-01-03 18:12:59 +05:00
"password" : "string" ,
"token_extra" : {},
"type" : "string" ,
"url" : "string" ,
"username" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Responses
2023-10-09 18:04:35 -05:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
2023-10-09 18:04:35 -05:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [agentsdk.ExternalAuthResponse ](schemas.md#agentsdkexternalauthresponse ) |
2023-01-05 15:27:10 +01:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
## Get workspace agent Git SSH key
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-05 15:27:10 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitsshkey \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/me/gitsshkey`
2023-01-05 15:27:10 +01:00
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"private_key" : "string" ,
"public_key" : "string"
2023-01-05 15:27:10 +01:00
}
```
### Responses
2023-01-29 15:47:24 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|----------------------------------------------------|
2023-01-29 15:47:24 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [agentsdk.GitSSHKey ](schemas.md#agentsdkgitsshkey ) |
2023-01-05 15:27:10 +01:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2024-06-03 12:29:50 -05:00
## Post workspace agent log source
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2024-06-03 12:29:50 -05:00
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/log-source \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`POST /api/v2/workspaceagents/me/log-source`
2024-06-03 12:29:50 -05:00
> Body parameter
```json
{
2025-01-03 18:12:59 +05:00
"display_name" : "string" ,
"icon" : "string" ,
"id" : "string"
2024-06-03 12:29:50 -05:00
}
```
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|--------|------|--------------------------------------------------------------------------|----------|--------------------|
2024-06-03 12:29:50 -05:00
| `body` | body | [agentsdk.PostLogSourceRequest ](schemas.md#agentsdkpostlogsourcerequest ) | true | Log source request |
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"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"
2024-06-03 12:29:50 -05:00
}
```
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------|
2024-06-03 12:29:50 -05:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [codersdk.WorkspaceAgentLogSource ](schemas.md#codersdkworkspaceagentlogsource ) |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-07-28 09:57:23 -06:00
## Patch workspace agent logs
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-07-28 09:57:23 -06:00
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/logs \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`PATCH /api/v2/workspaceagents/me/logs`
2023-07-28 09:57:23 -06:00
> Body parameter
```json
{
2025-01-03 18:12:59 +05:00
"log_source_id" : "string" ,
"logs" : [
{
"created_at" : "string" ,
"level" : "trace" ,
"output" : "string"
}
]
2023-07-28 09:57:23 -06:00
}
```
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|--------|------|----------------------------------------------------|----------|-------------|
2023-07-28 09:57:23 -06:00
| `body` | body | [agentsdk.PatchLogs ](schemas.md#agentsdkpatchlogs ) | true | logs |
2023-07-13 09:24:09 -04:00
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"detail" : "string" ,
"message" : "string" ,
"validations" : [
{
"detail" : "string" ,
"field" : "string"
}
]
2023-07-13 09:24:09 -04:00
}
```
### Responses
2026-08-18 12:54:45 -07:00
| Status | Meaning | Description | Schema |
|--------|-------------------------------------------------------------------------|----------------------------------|--------------------------------------------------|
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [codersdk.Response ](schemas.md#codersdkresponse ) |
| 413 | [Payload Too Large ](https://tools.ietf.org/html/rfc7231#section-6.5.11 ) | Agent log storage limit exceeded | [codersdk.Response ](schemas.md#codersdkresponse ) |
2023-07-13 09:24:09 -04:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2025-05-14 14:15:36 +02:00
## Get workspace agent reinitialization
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2025-05-14 14:15:36 +02:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/reinit \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/me/reinit`
2025-05-14 14:15:36 +02:00
2026-04-02 23:51:02 +02:00
### Parameters
| Name | In | Type | Required | Description |
|--------|-------|---------|----------|---------------------------------|
| `wait` | query | boolean | false | Opt in to durable reinit checks |
2025-05-14 14:15:36 +02:00
### Example responses
> 200 Response
```json
{
2026-04-02 23:51:02 +02:00
"owner_id" : "8826ee2e-7933-4665-aef2-2393f84a0d05" ,
2025-05-14 14:15:36 +02:00
"reason" : "prebuild_claimed" ,
2026-04-02 23:51:02 +02:00
"workspace_id" : "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
2025-05-14 14:15:36 +02:00
}
```
### Responses
2026-04-02 23:51:02 +02:00
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------------|-------------|----------------------------------------------------------------------------|
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [agentsdk.ReinitializationEvent ](schemas.md#agentsdkreinitializationevent ) |
| 409 | [Conflict ](https://tools.ietf.org/html/rfc7231#section-6.5.8 ) | Conflict | [codersdk.Response ](schemas.md#codersdkresponse ) |
2025-05-14 14:15:36 +02:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-01-13 12:27:21 +01:00
## Get workspace agent by ID
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-13 12:27:21 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}`
2023-01-13 12:27:21 +01:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|------------------|------|--------------|----------|--------------------|
2023-01-13 12:27:21 +01:00
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"api_version" : "string" ,
"apps" : [
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
2025-05-27 13:13:08 -06:00
"group" : "string" ,
2025-01-03 18:12:59 +05:00
"health" : "disabled" ,
"healthcheck" : {
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
},
"hidden" : true ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
2025-01-07 18:08:03 +01:00
"open_in" : "slim-window" ,
2025-01-03 18:12:59 +05:00
"sharing_level" : "owner" ,
"slug" : "string" ,
2025-03-31 10:55:44 -04:00
"statuses" : [
{
"agent_id" : "2b1e3b65-2c04-4fa2-a2d7-467901e98978" ,
"app_id" : "affd1d10-9538-4fc8-9e0b-4594a28c1335" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"message" : "string" ,
"needs_user_attention" : true ,
"state" : "working" ,
"uri" : "string" ,
"workspace_id" : "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
],
2025-01-03 18:12:59 +05:00
"subdomain" : true ,
"subdomain_name" : "string" ,
2025-09-10 11:01:54 -05:00
"tooltip" : "string" ,
2025-01-03 18:12:59 +05:00
"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 ,
2026-08-10 08:13:32 -05:00
"metadata" : [
{
"description" : {
"display_name" : "string" ,
"interval" : 0 ,
"key" : "string" ,
"script" : "string" ,
"timeout" : 0
},
"result" : {
"age" : 0 ,
"collected_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"value" : "string"
}
}
],
2025-01-03 18:12:59 +05:00
"name" : "string" ,
"operating_system" : "string" ,
2026-08-27 09:13:33 -07:00
"parent_id" : "1c6ca187-e61f-4301-8dcb-0e9749e89eef" ,
2025-01-03 18:12:59 +05:00
"ready_at" : "2019-08-24T14:15:22Z" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"scripts" : [
{
"cron" : "string" ,
"display_name" : "string" ,
2026-04-29 12:24:26 -08:00
"exit_code" : 0 ,
2025-01-03 18:12:59 +05:00
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"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 ,
2026-04-29 12:24:26 -08:00
"status" : "ok" ,
2025-01-03 18:12:59 +05:00
"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"
2023-01-13 12:27:21 +01:00
}
```
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------|
2023-01-13 12:27:21 +01:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [codersdk.WorkspaceAgent ](schemas.md#codersdkworkspaceagent ) |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
## Get connection info for workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-13 12:27:21 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /connection \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/connection`
2023-01-13 12:27:21 +01:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|------------------|------|--------------|----------|--------------------|
2023-01-13 12:27:21 +01:00
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"derp_force_websockets" : true ,
"derp_map" : {
"homeParams" : {
"regionScore" : {
"property1" : 0 ,
"property2" : 0
}
},
"omitDefaultRegions" : true ,
"regions" : {
"property1" : {
"avoid" : true ,
"embeddedRelay" : true ,
"nodes" : [
{
"canPort80" : true ,
"certName" : "string" ,
"derpport" : 0 ,
"forceHTTP" : true ,
"hostName" : "string" ,
"insecureForTests" : true ,
"ipv4" : "string" ,
"ipv6" : "string" ,
"name" : "string" ,
"regionID" : 0 ,
"stunonly" : true ,
"stunport" : 0 ,
"stuntestIP" : "string"
}
],
"regionCode" : "string" ,
"regionID" : 0 ,
"regionName" : "string"
},
"property2" : {
"avoid" : true ,
"embeddedRelay" : true ,
"nodes" : [
{
"canPort80" : true ,
"certName" : "string" ,
"derpport" : 0 ,
"forceHTTP" : true ,
"hostName" : "string" ,
"insecureForTests" : true ,
"ipv4" : "string" ,
"ipv6" : "string" ,
"name" : "string" ,
"regionID" : 0 ,
"stunonly" : true ,
"stunport" : 0 ,
"stuntestIP" : "string"
}
],
"regionCode" : "string" ,
"regionID" : 0 ,
"regionName" : "string"
}
}
},
2025-04-11 13:09:51 +04:00
"disable_direct_connections" : true ,
"hostname_suffix" : "string"
2023-01-13 12:27:21 +01:00
}
```
### Responses
2024-03-26 12:44:31 -05:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------|
2024-03-26 12:44:31 -05:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [workspacesdk.AgentConnectionInfo ](schemas.md#workspacesdkagentconnectioninfo ) |
2023-01-13 12:27:21 +01:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2025-02-10 11:29:30 +00:00
## Get running containers for workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2025-02-10 11:29:30 +00:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /containers?label= string \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/containers`
2025-02-10 11:29:30 +00:00
### Parameters
| Name | In | Type | Required | Description |
|------------------|-------|-------------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
| `label` | query | string(key=value) | true | Labels |
### Example responses
> 200 Response
```json
{
"containers" : [
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"image" : "string" ,
"labels" : {
"property1" : "string" ,
"property2" : "string"
},
"name" : "string" ,
"ports" : [
{
2025-03-18 14:37:45 +00:00
"host_ip" : "string" ,
"host_port" : 0 ,
2025-02-10 11:29:30 +00:00
"network" : "string" ,
2025-03-18 14:37:45 +00:00
"port" : 0
2025-02-10 11:29:30 +00:00
}
],
"running" : true ,
"status" : "string" ,
"volumes" : {
"property1" : "string" ,
"property2" : "string"
}
}
],
2025-06-17 16:06:47 +03:00
"devcontainers" : [
{
"agent" : {
"directory" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string"
},
"config_path" : "string" ,
"container" : {
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"image" : "string" ,
"labels" : {
"property1" : "string" ,
"property2" : "string"
},
"name" : "string" ,
"ports" : [
{
"host_ip" : "string" ,
"host_port" : 0 ,
"network" : "string" ,
"port" : 0
}
],
"running" : true ,
"status" : "string" ,
"volumes" : {
"property1" : "string" ,
"property2" : "string"
}
},
"dirty" : true ,
2025-06-30 21:34:29 +01:00
"error" : "string" ,
2025-06-17 16:06:47 +03:00
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"status" : "running" ,
2026-08-27 09:13:33 -07:00
"subagent_id" : "7b85d465-b649-4b8b-9da8-5f731c1d294d" ,
2025-06-17 16:06:47 +03:00
"workspace_folder" : "string"
}
],
2025-02-10 11:29:30 +00:00
"warnings" : [
"string"
]
}
```
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------|
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [codersdk.WorkspaceAgentListContainersResponse ](schemas.md#codersdkworkspaceagentlistcontainersresponse ) |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2025-12-24 12:34:39 +00:00
## Delete devcontainer for workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2025-12-24 12:34:39 +00:00
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /containers/devcontainers/{ devcontainer} \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`DELETE /api/v2/workspaceagents/{workspaceagent}/containers/devcontainers/{devcontainer}`
2025-12-24 12:34:39 +00:00
### Parameters
| Name | In | Type | Required | Description |
|------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
| `devcontainer` | path | string | true | Devcontainer ID |
### Responses
| Status | Meaning | Description | Schema |
|--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content ](https://tools.ietf.org/html/rfc7231#section-6.3.5 ) | No Content | |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2025-05-19 12:56:10 +03:00
## Recreate devcontainer for workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2025-05-19 12:56:10 +03:00
# Example request using curl
2025-06-26 11:41:57 +01:00
curl -X POST http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /containers/devcontainers/{ devcontainer} /recreate \
2025-05-26 18:30:52 +03:00
-H 'Accept: application/json' \
2025-05-19 12:56:10 +03:00
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`POST /api/v2/workspaceagents/{workspaceagent}/containers/devcontainers/{devcontainer}/recreate`
2025-05-19 12:56:10 +03:00
### Parameters
2025-06-26 11:41:57 +01:00
| Name | In | Type | Required | Description |
|------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
| `devcontainer` | path | string | true | Devcontainer ID |
2025-05-19 12:56:10 +03:00
2025-05-26 18:30:52 +03:00
### Example responses
> 202 Response
```json
{
"detail" : "string" ,
"message" : "string" ,
"validations" : [
{
"detail" : "string" ,
"field" : "string"
}
]
}
```
2025-05-19 12:56:10 +03:00
### Responses
2025-05-26 18:30:52 +03:00
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------------|-------------|--------------------------------------------------|
| 202 | [Accepted ](https://tools.ietf.org/html/rfc7231#section-6.3.3 ) | Accepted | [codersdk.Response ](schemas.md#codersdkresponse ) |
2025-05-19 12:56:10 +03:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2025-07-14 21:35:35 +01:00
## Watch workspace agent for container updates
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2025-07-14 21:35:35 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /containers/watch \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/containers/watch`
2025-07-14 21:35:35 +01:00
### Parameters
| Name | In | Type | Required | Description |
|------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Example responses
> 200 Response
```json
{
"containers" : [
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"image" : "string" ,
"labels" : {
"property1" : "string" ,
"property2" : "string"
},
"name" : "string" ,
"ports" : [
{
"host_ip" : "string" ,
"host_port" : 0 ,
"network" : "string" ,
"port" : 0
}
],
"running" : true ,
"status" : "string" ,
"volumes" : {
"property1" : "string" ,
"property2" : "string"
}
}
],
"devcontainers" : [
{
"agent" : {
"directory" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string"
},
"config_path" : "string" ,
"container" : {
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"image" : "string" ,
"labels" : {
"property1" : "string" ,
"property2" : "string"
},
"name" : "string" ,
"ports" : [
{
"host_ip" : "string" ,
"host_port" : 0 ,
"network" : "string" ,
"port" : 0
}
],
"running" : true ,
"status" : "string" ,
"volumes" : {
"property1" : "string" ,
"property2" : "string"
}
},
"dirty" : true ,
"error" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"status" : "running" ,
2026-08-27 09:13:33 -07:00
"subagent_id" : "7b85d465-b649-4b8b-9da8-5f731c1d294d" ,
2025-07-14 21:35:35 +01:00
"workspace_folder" : "string"
}
],
"warnings" : [
"string"
]
}
```
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------|
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [codersdk.WorkspaceAgentListContainersResponse ](schemas.md#codersdkworkspaceagentlistcontainersresponse ) |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-01-13 12:27:21 +01:00
## Coordinate workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-13 12:27:21 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /coordinate \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/coordinate`
2023-01-13 12:27:21 +01:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|------------------|------|--------------|----------|--------------------|
2023-01-13 12:27:21 +01:00
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|--------------------------------------------------------------------------|---------------------|--------|
2023-01-13 12:27:21 +01:00
| 101 | [Switching Protocols ](https://tools.ietf.org/html/rfc7231#section-6.2.2 ) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
## Get listening ports for workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-13 12:27:21 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /listening-ports \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/listening-ports`
2023-01-13 12:27:21 +01:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|------------------|------|--------------|----------|--------------------|
2023-01-13 12:27:21 +01:00
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Example responses
> 200 Response
```json
{
2025-01-03 18:12:59 +05:00
"ports" : [
{
"network" : "string" ,
"port" : 0 ,
"process_name" : "string"
}
]
2023-01-13 12:27:21 +01:00
}
```
### Responses
2023-01-29 15:47:24 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------|
2023-01-29 15:47:24 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | [codersdk.WorkspaceAgentListeningPortsResponse ](schemas.md#codersdkworkspaceagentlisteningportsresponse ) |
2023-01-13 12:27:21 +01:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-07-28 09:57:23 -06:00
## Get logs by workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-07-28 09:57:23 -06:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /logs \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/logs`
2023-07-28 09:57:23 -06:00
### Parameters
2026-02-03 09:45:23 +00:00
| Name | In | Type | Required | Description |
|------------------|-------|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
| `before` | query | integer | false | Before log id |
| `after` | query | integer | false | After log id |
| `follow` | query | boolean | false | Follow log stream |
| `no_compression` | query | boolean | false | Disable compression for WebSocket connection |
| `format` | query | string | false | Log output format. Accepted: 'json' (default), 'text' (plain text with RFC3339 timestamps and ANSI colors). Not supported with follow=true. |
#### Enumerated Values
| Parameter | Value(s) |
|-----------|----------------|
| `format` | `json` , `text` |
2023-07-28 09:57:23 -06:00
### Example responses
> 200 Response
```json
[
2025-01-03 18:12:59 +05:00
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : 0 ,
"level" : "trace" ,
"output" : "string" ,
"source_id" : "ae50a35c-df42-4eff-ba26-f8bc28d2af81"
}
2023-07-28 09:57:23 -06:00
]
```
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
2023-07-28 09:57:23 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | array of [codersdk.WorkspaceAgentLog ](schemas.md#codersdkworkspaceagentlog ) |
<h3 id="get-logs-by-workspace-agent-responseschema">Response Schema</h3>
Status Code **200**
| Name | Type | Required | Restrictions | Description |
2025-01-03 18:12:59 +05:00
|----------------|--------------------------------------------------|----------|--------------|-------------|
2023-07-28 09:57:23 -06:00
| `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | |
| `» id` | integer | false | | |
| `» level` | [codersdk.LogLevel ](schemas.md#codersdkloglevel ) | false | | |
| `» output` | string | false | | |
2023-09-25 16:47:17 -05:00
| `» source_id` | string(uuid) | false | | |
2023-07-28 09:57:23 -06:00
#### Enumerated Values
2025-12-22 16:19:25 +01:00
| Property | Value(s) |
|----------|-------------------------------------------|
| `level` | `debug` , `error` , `info` , `trace` , `warn` |
2023-07-28 09:57:23 -06:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-01-13 12:27:21 +01:00
## Open PTY to workspace agent
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-01-13 12:27:21 +01:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /pty \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/pty`
2023-01-13 12:27:21 +01:00
### Parameters
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|------------------|------|--------------|----------|--------------------|
2023-01-13 12:27:21 +01:00
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Responses
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|--------------------------------------------------------------------------|---------------------|--------|
2023-01-13 12:27:21 +01:00
| 101 | [Switching Protocols ](https://tools.ietf.org/html/rfc7231#section-6.2.2 ) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).
2023-03-23 14:09:13 -05:00
2023-07-28 09:57:23 -06:00
## Removed: Get logs by workspace agent
2023-03-23 14:09:13 -05:00
### Code samples
2026-07-15 14:07:09 -04:00
```sh
2023-03-23 14:09:13 -05:00
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{ workspaceagent} /startup-logs \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
2026-05-05 02:54:03 +05:00
`GET /api/v2/workspaceagents/{workspaceagent}/startup-logs`
2023-03-23 14:09:13 -05:00
### Parameters
2023-06-20 16:29:32 +03:00
| Name | In | Type | Required | Description |
2025-01-03 18:12:59 +05:00
|------------------|-------|--------------|----------|----------------------------------------------|
2023-06-20 16:29:32 +03:00
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
| `before` | query | integer | false | Before log id |
| `after` | query | integer | false | After log id |
| `follow` | query | boolean | false | Follow log stream |
| `no_compression` | query | boolean | false | Disable compression for WebSocket connection |
2023-03-23 14:09:13 -05:00
### Example responses
> 200 Response
```json
[
2025-01-03 18:12:59 +05:00
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : 0 ,
"level" : "trace" ,
"output" : "string" ,
"source_id" : "ae50a35c-df42-4eff-ba26-f8bc28d2af81"
}
2023-03-23 14:09:13 -05:00
]
```
### Responses
2023-07-28 09:57:23 -06:00
| Status | Meaning | Description | Schema |
2025-01-03 18:12:59 +05:00
|--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
2023-07-28 09:57:23 -06:00
| 200 | [OK ](https://tools.ietf.org/html/rfc7231#section-6.3.1 ) | OK | array of [codersdk.WorkspaceAgentLog ](schemas.md#codersdkworkspaceagentlog ) |
2023-03-23 14:09:13 -05:00
2023-07-28 09:57:23 -06:00
<h3 id="removed:-get-logs-by-workspace-agent-responseschema">Response Schema</h3>
2023-03-23 14:09:13 -05:00
Status Code **200**
2023-06-20 14:41:55 +03:00
| Name | Type | Required | Restrictions | Description |
2025-01-03 18:12:59 +05:00
|----------------|--------------------------------------------------|----------|--------------|-------------|
2023-06-20 14:41:55 +03:00
| `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | |
| `» id` | integer | false | | |
| `» level` | [codersdk.LogLevel ](schemas.md#codersdkloglevel ) | false | | |
| `» output` | string | false | | |
2023-09-25 16:47:17 -05:00
| `» source_id` | string(uuid) | false | | |
2023-04-10 14:29:59 -05:00
#### Enumerated Values
2025-12-22 16:19:25 +01:00
| Property | Value(s) |
|----------|-------------------------------------------|
| `level` | `debug` , `error` , `info` , `trace` , `warn` |
2023-03-23 14:09:13 -05:00
To perform this operation, you must be authenticated. [Learn more ](authentication.md ).