mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-30 10:56:20 +02:00
71 lines
No EOL
6.1 KiB
Text
71 lines
No EOL
6.1 KiB
Text
---
|
|
id: session-get
|
|
title: "Get Session"
|
|
description: "Retrieve information about a specific session."
|
|
sidebar_label: "Get Session"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVWF1z27YS/Ss7yEyn5dCSmvRJb66jm3ry0Yzl3j44Hg9ErEhEIMBgQTuqRv/9zgKkRMlO43t1X/pkmQDO2V0sdg+wEUGWJKY3gpBIO0viNhcKqfC6CdpZMRVXGLzGewRtl87Xkj+DXLg2gARqsNBLXUC3fiRy4Rr0cdalEtMe+A0GkYtGelljQM+cG6EZv5GhErmwssb99Eslju24rhC0Qhv0UqMHt4RQ4ZDX45dWe1RiGnyLuaCiwlqK6UaEdROxg9e2FNvtLU+mxllC4vGXkwn/OeSbJ2Twnf8KqC0KJFq2xqyZsHA2oA28VDaN0UX0evyZeP3mMb9bfMYihsFzjIJO7Fo9tvEp51urv7R/G4NtLoJboX0eXrcM4pIcnDVr0EsonFtpBNmGiomSU6AJlCa5MKgiT+PdUht8HDZG7gYPMqaztSX0HLuvZ33m1VgvOCFu8+/EKWXIczzjmT1hgo82a7qTqtbD8CycMyjtI5RLq9hzJI7IHobDIC1ElAhZSHtnXHkSZiEtGFfCALJw1nIITgPtUHaoDzIU1YmYEWOHWDk61UiG2OFRJT3e1ai0PBE2IkFE2qHLeHzvCqObhZNenUiR4OLXHWTkIrSK7rSVRdD3eFe0npw/gSziQY8HCW8fM8RjLjo1eIjHdJROvWlLbempmiaV0gwtzcfBqU2V+JD5fDcTEh4QhqBtyRxcwnTgwiLeR4M+doWG4xpk+EbFKVrv0QaIU57oDd+pwNSfOPyfkoKLGpeGHUhfbuJp4Sp1AmiPcRicrjvNY0ieGHgtgxTbLY/8Mvn56aBxw0QK0DVOSpSHhf//2OdqJJLlM0r4awxSG1SA3jsP3bpD/2c89L5D7P189bSfhP4ePbRWoafgnIrx7bzPYdFyCJYtIUFw0X/n9V8IOvyjvP/lG94niYYKPJJrfYHwIAmsC7B0rVX/GB+3uagxVI5VZdnJyVCJqRjLRo97ATve7CTkVnAt5r1PcvPQhneukKbLDZGL1hsxFVUIzXQ8NjzGnWn6ajKZCBaMhEXrdVhHpF9RevTnLdPf3G7zjbiIqmn45Zpl1e7DAGHO0UwBG67axUw2+i2uRZ7kcZJje4H8Yfb297v5bD6//P3Do7ieH4q2lrQtWaV3Si9hxeI09GDHzN6LTjjHWhUnPZclQSY5GTkGEfiGc19a9Ou9b0m8PpMuToZGEqECSSAhosHujpHSiTVo5O/S6gOuHJx/vBS54MRIFK9Gk9HkEXGcGsvCn7i4ur4AaRX/nLtihQEWSFohwdVsfs2IXDwa7+614uIizVnQNQL/64CCR1lrW+agbUDf91ZnjFy4dF3KI77H2gUEhbQKroFla4vULHVYjz7ZT/bFixdw4TzCNRaVdaw+kXjgDLLs35Ft3rOB48KXrM+yTxbgDKJXBu/RyxIJsqwfhqXze8NzMO7hzMiAtljnUOmyOvvSRjM6n9ha2So98G6UKN7iOqqhOKV2LSHgPdpAwKIseGmp1iGgSvbFXs2SvQtz10Z5s9kkQlkbVlq7yDk76h2+YnuvOdBzXXKUODesggtX163tc6YPQ9q5PhLR9f4Tt9qWUylS7sG07c36EUflKN8dJqQgF0ZTVaMNOVxezFg7Ka1YgeDXopK2xJ9GAInsXdzvSoY9QtvwXEr7vupiNk7xWkpjFrJYxYhV0irTR2tn8z4GfQKy6bN79OvAggFmhnDv69Ex+gH6C+57aWWJ7EWWwRnMuUzhU1og2tkbH23iLe8dzLIr5+o45w9eewR74VGGeABqp/RyHX/yZO493pkY7ETa6WoH3rmaBgSvu0NxkZZQBD5Xn1tiZKDCI8Zrz1KXbTpUlEPNhvD46ltpOeoJ5msKWMNvKE2o4Ad4z3f/IvF07yCRKE2r0rSiwmJFEXT39CENaEu6rEKyPx3b39wDXAY4Nwb+dH5FcO1KDBV6nvDzaHgW05ZTusHsD1jc4iw7Ki95dw7ZBCWDzLLRJ/tydJTgaKlllSchyxoufRRi5i600h67KpNlx8dvUAaGJzD59Wo0yL8s6+sfl5WltnhWeqkt7jY5y1IOD/a5q3qcOgcbF7P7XywOuNapKBgoZ6EWe0wsGvwSExNfuaLlTOtXilwYXaAl3D8ciPNGFhXCy1jpD9r9w8PDSMbRkfPluFtK43eXF7MP89nZy9FkVIXaxIbSOAq1tAPgNxj6w3TcQzZ7afXfP6R1LTPg1zBujNSWm2o0fNNJnxvup1HldK93uZjuX9Buc5Eu6Ddis1lIwj+82W75c+q705vbXNxLr/lZJymk7olHTJfS0PHNbejMj1fda9tP8N2HuSf96PWA5f5/L03L/4lcrHB98Ay4vd3mokKp0EcT0/h5UWATBisfyVZWXDu5+GZ2Lbbb/wD9j01w
|
|
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={"Get Session"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/api/sessions/{sessionId}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve information about a specific session.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"in":"path","name":"sessionId","description":"The identifier of the session.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Session retrieved successfully.","content":{"application/json":{"schema":{"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"}}}},"404":{"description":"The specified resource was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|