Generated from the live OpenAPI document — 2026-11-13.This group has no curated guide page.All routes require Authorization: Bearer atamaia_… and return ApiEnvelope<T>({ ok, requestId, data, error, errorCode, count, hint }); the schemas below show thedata payload. * marks required properties.
Operations
| Method | Path | Summary / body | Responses |
|---|
| GET |
/api/workspace-hosts |
|
200 PagedResultOfWorkspaceHostDto |
| POST |
/api/workspace-hosts |
|
200 WorkspaceHostDto |
| DELETE |
/api/workspace-hosts/{id} |
|
200 |
| GET |
/api/workspace-hosts/{id} |
|
200 WorkspaceHostDto |
| PATCH |
/api/workspace-hosts/{id} |
|
200 WorkspaceHostDto |
| POST |
/api/workspace-hosts/{id}/probe |
|
200 WorkspaceHostProbeResult |
Schemas
Request and response shapes referenced by the operations above. Nested types named here are also defined under their own group or inthe group index.
PagedResultOfWorkspaceHostDto
| Property | Type | Description |
|---|
| items* |
WorkspaceHostDto[] |
|
| totalCount |
int32 |
|
| page |
int32 |
|
| pageSize |
int32 |
|
| hasTotal |
boolean |
|
| moreAvailable |
null,boolean |
|
| totalPages |
int32 |
|
| hasNextPage |
boolean |
|
| hasPreviousPage |
boolean |
|
WorkspaceHostDto
| Property | Type | Description |
|---|
| id |
int64 |
|
| guid |
uuid |
|
| name |
string |
|
| host |
string |
|
| port |
int32 |
|
| userName |
string |
|
| authKind |
SshAuthKind |
|
| privateKeyPath |
null,string |
|
| passphraseEnvVar |
null,string |
|
| hostKeyFingerprint |
null,string |
|
| createdAtUtc |
date-time |
|
| updatedAtUtc |
date-time |
|
WorkspaceHostProbeResult
| Property | Type | Description |
|---|
| ok |
boolean |
|
| error |
null,string |
|
| hostKeyFingerprint |
null,string |
|
| pinnedNow |
boolean |
|
| remotePlatform |
null,string |
|