system.ping

GET · api v1

Checks that this server is linked to OrcaBot and returns the API version. Call it once when your resource starts.

يتأكد إن السيرفر مربوط بأوركا ويرجع نسخة الـ API. استخدمه مرة وحدة عند تشغيل السكربت.

Parameters

No parameters.

Returns (`res.data`)

Name	Type	Description
`connected`	`boolean`	The server is linked and authenticated.
`guild_name`	`string`	The Discord server this game server is linked to.
`api`	`number`	API version.
`server_time`	`string`	Backend time (ISO 8601, UTC).

Possible errors

Notes

If it fails with not_connected, link the server from the dashboard's FiveM page first.

Example

CreateThread(function()
    local res = exports.OrcaBot_V3:Get('system.ping')
    if res.ok then
        print(('OrcaBot linked to %s (api v%d)'):format(res.data.guild_name, res.data.api))
    else
        print('OrcaBot not ready: ' .. res.error.code)
    end
end)

Example output

{
  "ok": true,
  "data": {
    "connected": true,
    "guild_name": "مدينة أوركا - Orca City",
    "api": 1,
    "server_time": "2026-10-15T20:14:03Z"
  },
  "meta": {
    "action": "system.ping",
    "method": "GET",
    "api": 1
  }
}