Skip to content
You're viewing documentation for v2026.11.11-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

End remote assist

End the open session now. The tunnel closes, and each engineer loses access.

POST/api/v1/remote-assist/end
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

default_hoursinteger<int64>required
durationsinteger<int64>[]required

The durations that an admin can choose, in hours

end_reasonstringrequired

Why the last session ended, for example the console restarted

ended_atstring<date-time>

The end of the last session, when it ended

engineersRemoteAssistEngineer[]required

The engineers and cases that used the open or the last session

Show properties
Array of RemoteAssistEngineer
casestringrequired

The support case ID

engineerstringrequired

The engineer ID, for example TD-4821. Never a name or an email

first_seenstring<date-time>required
last_seenstring<date-time>required
expires_atstring<date-time>

The expiry of the open or the last session

opened_atstring<date-time>

The start of the open or the last session

opened_bystringrequired

The admin that turned on the open or the last session

reasonstringrequired

Why remote assist is not available, or empty

restartedbooleanrequired

Whether the last session ended because the console restarted

retrybooleanrequired

Whether remote assist is not available only because the last turn on could not reach Tiger Data, so an admin can try again

sessionsRemoteAssistSession[]required

The engineers that are active now

Show properties
Array of RemoteAssistSession
casestringrequired
engineerstringrequired
writebooleanrequired

Whether the engineer turned on read and write

statestringrequired

off; not_available (see reason); connecting: the tunnel to Tiger Data is down; on: no one is connected; session_active: an engineer sent a request in the last 2 minutes

Allowed:offnot_availableconnectingonsession_active
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X POST 'https://console.example.com/api/v1/remote-assist/end' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "default_hours": 0,
  "durations": [
    0
  ],
  "end_reason": "string",
  "ended_at": "2019-08-24T14:15:22Z",
  "engineers": [
    {
      "case": "string",
      "engineer": "string",
      "first_seen": "2019-08-24T14:15:22Z",
      "last_seen": "2019-08-24T14:15:22Z"
    }
  ],
  "expires_at": "2019-08-24T14:15:22Z",
  "opened_at": "2019-08-24T14:15:22Z",
  "opened_by": "string",
  "reason": "string",
  "restarted": true,
  "retry": true,
  "sessions": [
    {
      "case": "string",
      "engineer": "string",
      "write": true
    }
  ],
  "state": "off"
}