List a site's terminal sessions
Answers the newest 50 browser terminal sessions of a site, whoever opened them, and your own session when one is open now. A terminal is opened in the Control Panel, never through the API.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Returns
200 The sessions, newest first.
Fields of the 200 answer
Your own session on this site while one is open, else null.
The newest 50 sessions of the site, newest first.
Fields of each item
Null while the session is active.
Why the session ended, such as closed (the person closed it), idle or max_duration (it timed out: status is then timed_out), site_stopped, access_revoked (the person may no longer see the site), or socket_closed, connect_failed, exec_failed, error or lost when the connection or the shell failed. Null while the session is active.
Null while the session is active. Format: date-time.
At least 1.
A site by its id and domain.
Fields
Format: date-time.
activeendedtimed_outfailedThe session's recording.
Fields
True when the session has ended and its recording is kept.
When the recording is deleted. Null when there is none. Format: date-time.
The recording's address on the API (the transcript endpoint, with the session's id), when you may download it; null otherwise. It needs the exec scope.
Who opened the session, by their own id and name.
Fields
At least 1.
The person's name. Empty when the account no longer exists.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/sites/1042/terminal/sessions \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/terminal/sessions');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/terminal/sessions', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/sites/1042/terminal/sessions",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"active": null,
"sessions": [
{
"duration_seconds": 600,
"end_reason": "closed",
"ended_at": "2026-11-03T09:26:40Z",
"id": 6318,
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"started_at": "2026-11-03T09:16:40Z",
"status": "ended",
"status_label": "Ended",
"transcript": {
"available": true,
"expires_at": "2027-02-01T09:26:40Z",
"url": "/api/corestack/terminal/sessions/6318/transcript"
},
"user": {
"id": 2041,
"name": "Eleanor Finch"
}
},
{
"duration_seconds": 1800,
"end_reason": "idle",
"ended_at": "2026-11-02T14:32:11Z",
"id": 6317,
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"started_at": "2026-11-02T14:02:11Z",
"status": "timed_out",
"status_label": "Timed out",
"transcript": {
"available": false,
"expires_at": null,
"url": null
},
"user": {
"id": 2041,
"name": "Eleanor Finch"
}
}
]
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}