Session Terminal
Operations of the Interactive Session API. Paths are relative to your deployment's API host.
GET /api/agent-session-api/sessions/{id}/terminal
Describe the terminal screens of a session for the caller: what the caller may do on each and whether an attach would be admitted now. Reads only.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json TerminalDescribeResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/agent-session-api/sessions/{id}/terminal/{screen}
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
screen | path | TerminalScreenParam | yes |
| Status | Description | Body |
|---|---|---|
| 101 | Switching Protocols: WebSocket upgrade accepted | |
| 403 | The attach was refused (problem response) | |
| 404 | Not found, or not visible to the caller | |
| 503 | The terminal is unavailable (problem response) |