API:Network/Info

From BNC4FREE
Revision as of 15:12, 11 July 2020 by Russell (talk | contribs) (→‎Parameters: In keeping with other pages that have this bolded..)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Resource URI

   https://api.bnc4free.com/network/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
network required The name of the network you wish to retrieve the information of Freenode
username optional (Staff Option) The username to retrieve information for AnotherTestyTest

Example Request

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

Example Response

   {
      "Freenode" : {
         "ident" : "test",
         "trustedfps" : [],
         "trustallcerts" : true,
         "floodprotect" : {
            "enabled" : true,
            "joindelay" : 0,
            "floodburst" : 9,
            "floodrate" : 2
         },
         "ircaway" : false,
         "connected" : true,
         "realname" : "TestyTest",
         "manageservers" : false,
         "trustpki" : true,
         "vhost" : "10.0.0.6",
         "nickname" : "TestyTest",
         "quitmsg" : "Goodbye dear friends",
         "usermask" : "TestyTest!test@my.host.name",
         "alternate" : "TestTesty",
         "name" : "Freenode",
         "irc.freenode.net" : {
            "host" : "irc.freenode.net",
            "port" : 6667,
            "password" : "",
            "current" : true
         },
         "modules" : {
            "modules_online" : {
               "loaded" : false,
               "description" : "Makes ZNC's *modules to be \"online\".",
               "name" : "modules_online"
            },
            "autoreply" : {
               "name" : "autoreply",
               "description" : "Reply to queries when you are away",
               "loaded" : false
            },
            "log" : {
               "loaded" : false,
               "description" : "Writes IRC logs.",
               "name" : "log"
            },
            "stickychan" : {
               "loaded" : false,
               "description" : "configless sticky chans, keeps you there very stickily even",
               "name" : "stickychan"
            },
            "buffextras" : {
               "loaded" : true,
               "name" : "buffextras",
               "description" : "Adds joins, parts etc. to the playback buffer"
            },
            "sasl" : {
               "loaded" : false,
               "description" : "Adds support for sasl authentication capability to authenticate to an IRC server",
               "name" : "sasl"
            },
            "kickrejoin" : {
               "loaded" : false,
               "description" : "Autorejoins on kick",
               "name" : "kickrejoin"
            },
            "block_motd" : {
               "name" : "block_motd",
               "description" : "Block the MOTD from IRC so it's not sent to your client(s).",
               "loaded" : false
            },
            "alias" : {
               "description" : "Provides bouncer-side command alias support.",
               "name" : "alias",
               "loaded" : false
            },
            "perform" : {
               "description" : "Keeps a list of commands to be executed when ZNC connects to IRC.",
               "name" : "perform",
               "loaded" : true
            },
            "keepnick" : {
               "name" : "keepnick",
               "description" : "Keeps trying for your primary nick",
               "loaded" : false
            },
            "autovoice" : {
               "description" : "Auto voice the good people",
               "name" : "autovoice",
               "loaded" : false
            },
            "cert" : {
               "loaded" : false,
               "name" : "cert",
               "description" : "Use a ssl certificate to connect to a server"
            },
            "raw" : {
               "loaded" : false,
               "name" : "raw",
               "description" : "View all of the raw traffic"
            },
            "q" : {
               "loaded" : false,
               "name" : "q",
               "description" : "Auths you with QuakeNet's Q bot."
            },
            "away" : {
               "description" : "This module will automatically set you away on IRC while you are disconnected from the bouncer.",
               "name" : "away",
               "loaded" : false
            },
            "route_replies" : {
               "loaded" : false,
               "description" : "Send replies (e.g. to /who) to the right client only",
               "name" : "route_replies"
            },
            "autoop" : {
               "description" : "Auto op the good people",
               "name" : "autoop",
               "loaded" : false
            },
            "autocycle" : {
               "loaded" : false,
               "name" : "autocycle",
               "description" : "Rejoins channels to gain Op if you're the only user left"
            },
            "modtcl" : {
               "name" : "modtcl",
               "description" : "Loads Tcl scripts as ZNC modules",
               "loaded" : false
            },
            "nickserv" : {
               "description" : "Auths you with NickServ (prefer SASL module instead)",
               "name" : "nickserv",
               "loaded" : false
            },
            "chansaver" : {
               "name" : "chansaver",
               "description" : "Keeps config up-to-date when user joins/parts.",
               "loaded" : false
            },
            "stripcontrols" : {
               "name" : "stripcontrols",
               "description" : "Strips control codes (Colors, Bold, ..) from channel and private messages.",
               "loaded" : false
            },
            "autoattach" : {
               "name" : "autoattach",
               "description" : "Reattaches you to channels on activity.",
               "loaded" : false
            },
            "watch" : {
               "loaded" : false,
               "name" : "watch",
               "description" : "Copy activity from a specific user into a separate window"
            }
         },
         "autoconnect" : true,
         "clientsconnected" : 0,
         "attached" : false,
         "clients" : [],
         "clientencoding" : ""
      },
      "status" : "success",
      "username" : "TestyTest"
   }