Skip to main content
GET
/
api
/
v1
/
terminal
/
sessions
List terminal sessions
curl --request GET \
  --url http://localhost:3001/api/v1/terminal/sessions \
  --cookie nut-session=
{
  "sessions": [
    {
      "id": "<string>",
      "taskId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "lastActivity": "2023-11-07T05:31:56Z",
      "connected": true,
      "preview": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
nut-session
string
cookie
required

Session cookie authentication

Query Parameters

​
taskId
string

Filter sessions by task ID

​
sessionId
string

Fetch a specific session by ID

​
withPreview
enum<string>

Include a terminal output preview for each session

Available options:
1,
true,
yes
​
lines
integer
default:4

Number of preview lines to return (max 10, default 4)

Required range: x <= 10
​
previewBytes
integer
default:4096

Max bytes to scan for preview (max 8192, default 4096)

Required range: x <= 8192
​
colorize
enum<string>

Keep ANSI escape codes in preview output

Available options:
1,
true,
yes

Response

List of terminal sessions

​
sessions
object[]