For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sessions API

API calls for user session operations.

Base path: /sessions/

This API can be used to control user sessions. You can list active sessions, disconnect users, and send messages that will be displayed to users.

List Sessions

GET /sessions/

Queries the active sessions on the Autosky platform.

Status: 200 OK

Query Parameters (optional)

Parameter
Type
Description

cli_uuid

string

Client UUID for filtering

Response

Status: 200 OK

[
  {
    "ssid": "9cfb4863",
    "client": {},
    "user": {},
    "instance": {},
    "creation_date": "2017-10-02T18:35:14.470434Z",
    "termination_date": null,
    "termination_reason": "",
    "status": "active",
    "my_ip": "99.99.99.99"
  }
]

Session Object Fields

Field
Type
Description

ssid

string

Unique session identifier

client

object

Associated client data

user

object

Associated user data

instance

object

Instance data

creation_date

string

Session creation date/time (ISO 8601)

termination_date

string/null

Session termination date/time

termination_reason

string

Reason for termination

status

string

Session status (e.g., active)

my_ip

string

User IP

Get Session Data

Gets data for a session specified by its identifier.

Status: 200 OK

Path Parameters

Parameter
Required
Description

ssid

Yes

Unique session ID

Response

Status: 200 OK

Returns the session object with the same structure as the listing.

Remove Session

DELETE /sessions/{ssid}

Procedure for removing or disconnecting a user.

When used, sends a disconnection message to the user with a shutdown timer. If the user does not close the session spontaneously, the session is terminated within the defined timer, in minutes.

Path Parameters

Parameter
Required
Description

ssid

Yes

Unique session ID

Request Body

Field
Type
Required
Description

time

number

Yes

Time in minutes for session termination

message

string

No

Disconnection warning message

Request Example

Response

Status: 200 OK

Last updated

Was this helpful?