BROWSE DOCUMENTATION
Documentation / Ping

Ping

Confirm that the local WebSocket server accepts and answers commands.

Overview

Ping is a connectivity check. It does not inspect accounts or start a Roblox process.


Usage

Text
Ping

With password protection enabled, send AUTH <password> | Ping.


Complete Python example

Python
import asyncio
import websockets
import json

URI = "ws://localhost:8765"

async def main():
    async with websockets.connect(URI) as ws:
        print("Connected to WebSocket server")

        await ws.send("Ping")

        response = await ws.recv()
        print(json.loads(response))

if __name__ == "__main__":
    asyncio.run(main())

Example response

JSON
{
  "ok": true,
  "result": "Pong"
}