API:User/Info

Resource URI

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

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

Example Request

   curl -XPOST 
    --url https://api.bnc4free.com/user/info 
    -d server=Apple
    -d username=TestyTest
    -d key=d681883383bcf7963427b1629d0b9963cf6335b5

Example Response

   {
      "status" : "success",
      "TestyTest" : {
         "channel" : {
            "defaultmodes" : "",
            "jointries" : 10,
            "autoclearbuffer" : true,
            "maxjoins" : 0,
            "buffersize" : 50
         },
         "queries" : {
            "maximumbuffer" : 50,
            "buffersize" : 50,
            "autoclearbuffer" : true
         },
         "network" : {
            "maximum" : 1,
            "timeout" : 180,
            "current" : 0,
            "pingfreq" : 90
         },
         "admin" : true,
         "setvhost" : "true",
         "disabled" : {
            "disabled" : false
         },
         "managenetworks" : true,
         "multiclients" : true,
         "user" : {
            "realname" : "Testy The Test",
            "alternate" : "TestTesty",
            "vhost" : "",
            "quitmsg" : "%znc%",
            "nickname" : "TestyTest",
            "ident" : "test"
         },
         "clients" : [
            "10.0.0.2"
         ],
         "timezone" : "",
         "whitelist" : [
            "*"
         ],
         "clientencoding" : "",
         "loadmodules" : true,
         "clientsconnected" : 2,
         "tsformat" : "[%H:%M:%S]",
         "modules" : {
            "missingmotd" : {
               "description" : "Sends 422 to clients when they login",
               "loaded" : false,
               "name" : "missingmotd"
            },
            "buffextras" : {
               "loaded" : false,
               "name" : "buffextras",
               "description" : "Adds joins, parts etc. to the playback buffer"
            },
            "block_motd" : {
               "description" : "Block the MOTD from IRC so it's not sent to your client(s).",
               "name" : "block_motd",
               "loaded" : false
            },
            "disconkick" : {
               "loaded" : false,
               "name" : "disconkick",
               "description" : "Kicks the client from all channels when the connection to the IRC server is lost"
            },
            "autoattach" : {
               "description" : "Reattaches you to channels on activity.",
               "loaded" : false,
               "name" : "autoattach"
            },
            "webadmin" : {
               "description" : "Web based administration module.",
               "loaded" : true,
               "name" : "webadmin"
            },
            "stripcontrols" : {
               "loaded" : false,
               "name" : "stripcontrols",
               "description" : "Strips control codes (Colors, Bold, ..) from channel and private messages."
            },
            "autoreply" : {
               "loaded" : false,
               "name" : "autoreply",
               "description" : "Reply to queries when you are away"
            },
            "clientnotify" : {
               "description" : "Notifies you when another IRC client logs into or out of your account. Configurable.",
               "loaded" : false,
               "name" : "clientnotify"
            },
            "notes" : {
               "description" : "Keep and replay notes",
               "loaded" : false,
               "name" : "notes"
            },
            "clearbufferonmsg" : {
               "name" : "clearbufferonmsg",
               "loaded" : false,
               "description" : "Clears all channel and query buffers whenever the user does something"
            },
            "controlpanel" : {
               "description" : "Dynamic configuration through IRC. Allows editing only yourself if you're not ZNC admin.",
               "loaded" : true,
               "name" : "controlpanel"
            },
            "chansaver" : {
               "description" : "Keeps config up-to-date when user joins/parts.",
               "name" : "chansaver",
               "loaded" : false
            },
            "listsockets" : {
               "description" : "Lists active sockets",
               "name" : "listsockets",
               "loaded" : false
            },
            "cert" : {
               "loaded" : false,
               "name" : "cert",
               "description" : "Use a ssl certificate to connect to a server"
            },
            "ctcpflood" : {
               "description" : "Don't forward CTCP floods to clients",
               "loaded" : false,
               "name" : "ctcpflood"
            },
            "perform" : {
               "name" : "perform",
               "loaded" : false,
               "description" : "Keeps a list of commands to be executed when ZNC connects to IRC."
            },
            "log" : {
               "description" : "Writes IRC logs.",
               "name" : "log",
               "loaded" : false
            },
            "alias" : {
               "description" : "Provides bouncer-side command alias support.",
               "name" : "alias",
               "loaded" : false
            },
            "flooddetach" : {
               "loaded" : false,
               "name" : "flooddetach",
               "description" : "Detach channels when flooded"
            },
            "raw" : {
               "description" : "View all of the raw traffic",
               "loaded" : false,
               "name" : "raw"
            }
         },
         "username" : "TestyTest",
         "statusprefix" : "*"
      }
   }