API:User/Update

From BNC4FREE
Jump to navigation Jump to search

Resource URI

   https://api.bnc4free.com/user/update

Parameters

Variable Required Description Example
server required The name of the server Apple
username required Your Username TestyTest
key required Your API Key d681883383bcf7963427b1629d0b9963cf6335b5
username optional (Staff Option) The username to retrieve information for AnotherTestyTest
Variable Required Description Example
multiclients optional Allow or Disallow multiple clients to connect to the user (True/False) true
statusprefix optional The status prefix that will be used when querying modules *
nickname optional The nickname that your account uses by default MyNickname
alternate optional The alternative nickname that your account uses by default MyAltNickname
ident optional The ident that your account will use by default its.me
realname optional The realname that your account will use my default Hey its me!
quitmsg optional The quit message that will shown when you quit a network by default Oh nooo, help!
tsformat optional The timestamp format that is used for playback buffers [%H:%M:%S]
defaultmodes optional The default modes that will be set on a channel when you join it +nt
jointries optional The amount of times the bouncer will attempt to join a channel before giving up 3
maxjoins optional The maximum number of channels that can be sent in JOIN to prevent excess flood 3
cbuffersize optional The maximum amount of lines to store for each channel playback buffer 300
notraffictimeout optional The number of seconds the bouncer waits before it receives something from network before declaring a connection timeout 30
qbuffersize optional The maximum amount of lines to store for each private message playback buffer 300
maxquerybuffer optional The maximum number of private message buffers to store 50
vhost optional (Staff Only) The default IP/Vhost that the user will use when connecting to IRC Networks 10.0.0.6
maxnetworks optional (Staff Only) Set the maximum number of networks a user can have their account 3
managenetworks optional (Staff Only) Allow or Disallow the user add and remove their own networks (True/False) false
setvhost optional (Staff Only) Allow or Disallow the user to change their IP/Vhost (True/False) false
loadmodules optional (Staff Only) Allow or Disallow the user to load modules on their user (True/False) false
admin optional (Staff Only) Allow or Disallow the user to manage accounts, networks and the bouncer itself (True/False) false
disabled optional (Staff Only) Enable or Disable a user account (True/False) false
disablereason optional (Staff Only) Set a reason for the account being disabled You have been terrible

Example Request

   curl -XPOST 
    --url https://api.bnc4free.com/user/update 
    -d server=Apple
    -d username=TestyTest
    -d nick=MyNewNick
    -d realname="i like rocks"
    -d key=d681883383bcf7963427b1629d0b9963cf6335b5

Example Response

   {
      "status" : "success",
      "TestyTest" : {
         "username" : "TestyTest",
         "user" : {
            "realname" : "i like rocks",
            "nick" : "MyNewNick"
         }
      }
   }