Difference between revisions of "API:Network/Server/Add"
Jump to navigation
Jump to search
(API Network Server Add Info) |
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 |
|- | |- | ||
| ircserver | | ircserver | ||
| required | | required | ||
| The IRC server to be added to the network | | The IRC server to be added to the network | ||
| − | | irc. | + | | irc.libera.chat |
|- | |- | ||
| ircport | | ircport | ||
| Line 56: | Line 56: | ||
-d username=TestyTest | -d username=TestyTest | ||
-d key=d681883383bcf7963427b1629d0b9963cf6335b5 | -d key=d681883383bcf7963427b1629d0b9963cf6335b5 | ||
| − | -d network= | + | -d network=LiberaChat |
| − | -d ircserver=irc. | + | -d ircserver=irc.libera.chat |
-d ircport=+6697 | -d ircport=+6697 | ||
| Line 63: | Line 63: | ||
{ | { | ||
"status" : "success", | "status" : "success", | ||
| − | " | + | "LiberaChat" : { |
| − | "irc. | + | "irc.libera.chat" : { |
| − | "host" : "irc. | + | "host" : "irc.libera.chat", |
"port" : "+6697", | "port" : "+6697", | ||
"password" : "" | "password" : "" | ||
} | } | ||
}, | }, | ||
| − | "networks" : " | + | "networks" : "LiberaChat" |
} | } | ||
[[Category:API_Functions]] | [[Category:API_Functions]] | ||
Latest revision as of 17:19, 26 May 2021
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 | LiberaChat |
| ircserver | required | The IRC server to be added to the network | irc.libera.chat |
| 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=LiberaChat
-d ircserver=irc.libera.chat
-d ircport=+6697
Example Response
{
"status" : "success",
"LiberaChat" : {
"irc.libera.chat" : {
"host" : "irc.libera.chat",
"port" : "+6697",
"password" : ""
}
},
"networks" : "LiberaChat"
}