Skip to content
Raster
Esc
navigateopen⌘Jpreview

list the machine's terminals

GET/v1/machines/{machine_id}/terminals
Authorization
AuthorizationBearer token · headerrequired
an organization api key. browser clients use the session cookie instead.
or
computer_sessionAPI key · cookierequired
first-party httponly browser session; never readable from javascript.
Path parameters
machine_idstringrequired
matches ^mch_[0-9a-z]{20,32}$
Responses
200OK
terminalsTerminal[]required
Show properties
Array of Terminal
idstringrequired
terminal identifier
min length 1 · max length 64 · matches ^[A-Za-z0-9_-]+$
colsintegerrequired
min -9007199254740991 · max 9007199254740991
rowsintegerrequired
min -9007199254740991 · max 9007199254740991
userstringrequired
commandstring[]required
created_atstring<date-time>required
attachedbooleanrequired
exitedbooleanrequired
exit_codeinteger | anyrequired
Show properties
Any of:
integer
integer
any
any
idle_timeout_secondsintegerrequired
min -9007199254740991 · max 9007199254740991
400invalid request
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
401unauthenticated
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
402quota exceeded
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
403permission denied
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
404not found
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
409conflict with current state
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
412precondition failed
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
429rate limited
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
500internal error
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
501unsupported operation
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
503compute unavailable
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.raster.sh/v1/v1/machines/mch_01h8xk2q4v9m3n7p5r0t/terminals" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "terminals": [
    {
      "id": "pty_01h8xk2q4v9m",
      "cols": -9007199254740991,
      "rows": -9007199254740991,
      "user": "string",
      "command": [
        "string"
      ],
      "created_at": "2026-08-19T12:00:00Z",
      "attached": true,
      "exited": true,
      "exit_code": -9007199254740991,
      "idle_timeout_seconds": -9007199254740991
    }
  ]
}