Skip to main content
GET
cURL

Authorizations

X-Cockroach-API-Session
string
header
required

Token for logged-in REST session. Use /login/ to log in and get a session token. For additional information, see cockroachlabs.com/docs/stable/cluster-api.

Query Parameters

username
string

Username of user to return sessions for; if unspecified, sessions from all users are returned.

limit
integer

Maximum number of results to return in this call.

start
string

Continuation token for results after a past limited run.

Response

200 - application/json

List sessions response.

errors
An error wrapper object for ListSessionsResponse. · object[]

Any errors that occurred during fan-out calls to other nodes.

next
string

The continuation token, for use in the next paginated call in the start parameter.

sessions
Session represents one SQL session. · object[]

A list of sessions on this node or cluster.