Difference between revisions of "API:User/Network/Add"

From BNC4FREE
Jump to navigation Jump to search
m (→‎Parameters: Add the vhost option)
 
Line 32: Line 32:
 
| '''(Staff Only)''' The username to add a network to
 
| '''(Staff Only)''' The username to add a network to
 
| AnotherTestyTest
 
| AnotherTestyTest
 +
|-
 +
| vhost
 +
| optional
 +
| '''(Staff Only)''' The IP/Vhost that the user will use when connecting to the IRC Network
 +
| 10.0.0.6
 
|}
 
|}
  

Latest revision as of 10:55, 3 July 2020

Resource URI

   https://api.bnc4free.com/user/network/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
username optional (Staff Only) The username to add a network to AnotherTestyTest
vhost optional (Staff Only) The IP/Vhost that the user will use when connecting to the IRC Network 10.0.0.6

Example Request

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

Example Response

   {
      "status" : "success",
      "username" : "TestyTest",
      "networks" : "Freenode"
   }