Difference between revisions of "API:User/Network/Add"
Jump to navigation
Jump to search
m (→Parameters: Add the vhost option) |
m (Replace references to Freenode) |
||
| Line 26: | Line 26: | ||
| required | | required | ||
| The name of the network to be added | | The name of the network to be added | ||
| − | | | + | | LiberaChat |
|- | |- | ||
| username | | username | ||
| Line 46: | Line 46: | ||
-d username=TestyTest | -d username=TestyTest | ||
-d key=d681883383bcf7963427b1629d0b9963cf6335b5 | -d key=d681883383bcf7963427b1629d0b9963cf6335b5 | ||
| − | -d network= | + | -d network=LiberaChat |
== Example Response == | == Example Response == | ||
| Line 52: | Line 52: | ||
"status" : "success", | "status" : "success", | ||
"username" : "TestyTest", | "username" : "TestyTest", | ||
| − | "networks" : " | + | "networks" : "LiberaChat" |
} | } | ||
[[Category:API_Functions]] | [[Category:API_Functions]] | ||
Latest revision as of 17:18, 26 May 2021
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 | LiberaChat |
| 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=LiberaChat
Example Response
{
"status" : "success",
"username" : "TestyTest",
"networks" : "LiberaChat"
}