API:Network/Server/Add

From BNC4FREE
Revision as of 19:58, 22 April 2020 by Russell (talk | contribs) (API Network Server Add Info)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Resource URI

   https://api.bnc4free.com/network/server/add

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 to be added Freenode
ircserver required The IRC server to be added to the network irc.freenode.net
ircport required The IRC port to be added to the network that corresponds with the server to be added +6697
ircpassword optional The IRC password that may be required to connect to the server being added password123
user optional (Staff Only) The username to add a server to a network for AnotherTestyTest

Example Request

   curl -XPOST 
    --url https://api.bnc4free.com/network/server/add
    -d server=Apple
    -d username=TestyTest
    -d key=d681883383bcf7963427b1629d0b9963cf6335b5
    -d network=Freenode
    -d ircserver=irc.freenode.net
    -d ircport=+6697

Example Response

   {
      "status" : "success",
      "Freenode" : {
          "irc.freenode.net" : {
              "host" : "irc.freenode.net",
              "port" : "+6697",
              "password" : ""
           }
      },
      "networks" : "Freenode"
   }