mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-30 10:56:20 +02:00
63 lines
No EOL
5.5 KiB
Text
63 lines
No EOL
5.5 KiB
Text
---
|
|
id: sessions-get
|
|
title: "List Sessions"
|
|
description: "Retrieve a list of all active sessions."
|
|
sidebar_label: "List Sessions"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVWE1z2zgS/StdSNXULouiNMmedPM62hlXPiZleXYOTsoFES0SEQgwaFCO1qX/vtUAScmys+sdnTYXKwTwuvuhPx75IIKsSMxvBSGRdpbEl1wopNLrNmhnxVxcY/AatwgSjKYAbg3SGJBl0FuE4VwhcuFa9JJPXSkxHxF/wSBy4ZFaZwlJzB/E69mM/zy2s+z3g+8NKqCuLJFo3RmzYwOlswFt4LOybY0uo7XpV2KAB0FljY3kX2HXopgL6b3ciVzogA0dPXerr1iyV61nn4NObml1tIeC17YSp2zc1Aid1d86BK3QBr3W6JmTUI9kFGKfi+A2aF+G1x+DeCQHZ80O9BpK5zYaQXahZkMpWNAESpNcGVTRTuvdWht8yicj94ug7dr5JgH0vnaEnjn9PhlSoMFmhT5mwH/mycoGXxYZ7xwMJvjos6Y7qRp9TM/KOYPSPkG5soojR2JGDjBMg7QQUSJkKe2dcdVZmKW0YFwFR5Cls5YpOA+0RxlR72Uo6zMxI8aIWDs610mGGPGolh7vGlRangkbkSAijegylvVdaXS7ctKrM00kuPh0hIy2CK2iO21Tr7orO0/On2Es4sGABwnvwBniqS06lzzEU3OUqt50lbbP9jSplGZoaT4dVW3wHZ5avhh3QsIDwhC0rdgGtzAduLGID9GhT32jYV6DDD/oOGXnPdoAccuTvvjfOoumoeLwTyUFNzVuDSPI0G5itXCXOgN0wHhMTj+2lpGSZxbeyiDFnv/l4m+zn59nzeO3DinEv9ojJZuPO/+fGYA/oLlBIlm9oIe/xSC1QQXovfPQn3tMwIKXPvSIQ5xvno+T0G/RQ2cVegrOqUhwH30Oq44pWHeEBMHF+J3X/0LQ4f8m+n0uGgy1YwlURenTylCLuZjKVk9HmcXNibngyXvK1HtXStNzJXLReSPmog6hnU+nhte4Vc/fzGYzsf/CQGXnddhFpL+j9OgvOjZ5+2WfP4jLKCOOn9ywzhgfHCEsmcFE0vGpg55q9TuMgordTPpE5L0eEB8X7367Wy6Wy6vfPj7h8uKxiulI2wrkKH0SVqzW4whGyxw9cxYd5OKNm15qJUEmfRVtHDHwg+C+deh3h9iSmnuhubgZWkmECiSBhIgGrfSywRBFELclu3bRfp9KH3Hj4OLTlcgFJ0Yy8aaYFbMnhuPWWCZ/4Or65hKkVfxz6coNBlghaYUE14vlDSNyMbXebbXiYpNmEnSDwP91QMGjbLStctA2oB+GjTNGrlzS83nE99i4gKCQNsG1sO5smaaHDrvis/1sX716BZfOI9xgWVvHcgyJFyaQZf+M1paDNXDcCJL3WfbZAkwgRmVwi15WSJBlwzKsnT84noNx9xMjA9pyl0Otq3ryrYtu9DGxt7JT+ii6Ipl4h7soD+KWxnWEgFu0gYBVSvDSUqNDQJX8i8OLNWxPcz9X+LLZJULZGJYeI3POFkPA1+zvDRO91BWzxLlhFVy6punskDMDDenmBiZi6MMjnj0dp1I0eQDTdnDrL1hURT4WE1KQK6OpbtCGHK4uFywmlFY8kvF7WUtb4V8LgGTsfbzvWoYDQtfyXkr3vuk5mya+1tKYlSw3kbFaWmUGtkafDxwMCciuL7bod4EnKCwM4SHWkzL6CfrRCR+klRVyFFkGE1hym8LnZmP0c3A++sRXPgSYZdfONXHP73z2BPbSowyxABqn9HoXf/JmnjfemUh2MtoLTQfeuYaODLzti+IyHaEIfKG+dsTIQKVHjO8Ba111qagoh4Yd4fXNj9KyGAwsdxSwgV9RmlDDT/CBX5LLZKd/Q4+G0rY6bStrLDcUQcd3c2lAW9JVHZL/qWx/dfdwFeDCGPjD+Q3Bjasw1Oh5w8/FcS2mK6ck6Q8FFq84y07aS97XIbugZJBZVny2r4uTBEdLHaseCVnWcuujEDN3pZX22HeZLDstv6M2cFyBKa43xVH+ZdnQ/7itrLXFSeWltjhecpalHD66577rceo8uriY3f9gQcC9TkWRQDkLlzhjYtPgTxYx8ZUrO8604aTIhdElWsLDm7S4aGVZI7yOnf7RuL+/vy9kXC2cr6b9UZq+v7pcfFwuJq+LWVGHxsSB0joKjbRHwO/5g83yoDkeTZGHg6D6Hz7y9NMy4PcwbY3Uludp9PmhVzq3PEqjwDl8Ukrvp7fi4WElCX/3Zr/nx2nKzm+/5GIrveavGkmkiBqlQh8lzQZ3zFFZYstyaitNl+b1iQRkJTNKr18WN2K//zd2Y5UK
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/neko-api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"List Sessions"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/api/sessions"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve a list of all active sessions.
|
|
|
|
<ParamsDetails
|
|
parameters={undefined}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Sessions retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the session."},"token":{"type":"string","description":"The session token, only if cookie authentication is disabled."},"profile":{"description":"The profile information of the user.","x-tags":["members"],"type":"object","properties":{"name":{"type":"string","description":"The name of the member."},"is_admin":{"type":"boolean","description":"Indicates if the member is an admin."},"can_login":{"type":"boolean","description":"Indicates if the member can log in."},"can_connect":{"type":"boolean","description":"Indicates if the member can connect."},"can_watch":{"type":"boolean","description":"Indicates if the member can watch."},"can_host":{"type":"boolean","description":"Indicates if the member can host."},"can_share_media":{"type":"boolean","description":"Indicates if the member can share media."},"can_access_clipboard":{"type":"boolean","description":"Indicates if the member can access the clipboard."},"sends_inactive_cursor":{"type":"boolean","description":"Indicates if the member sends inactive cursor."},"can_see_inactive_cursors":{"type":"boolean","description":"Indicates if the member can see inactive cursors."},"plugins":{"type":"object","additionalProperties":true,"description":"Additional plugin settings."}},"title":"MemberProfile"},"state":{"description":"The current state of the session.","type":"object","properties":{"is_connected":{"type":"boolean","description":"Indicates if the user is connected."},"is_watching":{"type":"boolean","description":"Indicates if the user is watching."}},"title":"SessionState"}},"title":"SessionData"}}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|