Skip to content

RCON API

Sam Collins edited this page Nov 20, 2016 · 1 revision

We have exposed all of https://github.com/Nizarii/arma-rcon-class-php in a rest api with the following URLs. The ? signifies an optional parameter.

  • ping - Returns version of RCON and time taken
  • players - Returns array of online players
  • bans - Returns array of bans
  • banPlayer/{player}/{time?}/{reason?} - Bans online player
  • addBan/{player}/{time?}/{reason?} - Adds ban to bans.txt
  • removeBan/{banId} - Removes ban from bans.txt
  • sayGlobal/{message} - Broadcasts global message
  • sayPlayer/{player}/{message} - Sends player a message

Responses

All responses are wrapped and will return the executed value as either true or false. This can be used to workout whether an action has been completed. The output from the call will be in response.

Examples

Ping

{"executed":true,"response":"1.214","time":0.031188}

Players (0 players online)

{"executed":true,"response":[]}

Failed

{"executed":false,"response":'Check your password'}
Clone this wiki locally