gns3-server/docs/api/v1/controller/server/servers.rst

/v1/controller/servers

POST /v1/controller/servers

Register a server

Response status codes

• 201: Server added

Input

Name	Mandatory	Type	Description
host	✔	string	Server host
password		string	Password for auth
port	✔	integer	Server port
protocol	✔	enum	Possible values: http, https
server_id	✔	string	Server identifier
user		string	User for auth

Output

Name	Mandatory	Type	Description
connected		boolean	True if controller is connected to the server
host	✔	string	Server host
port	✔	integer	Server port
protocol	✔	enum	Possible values: http, https
server_id	✔	string	Server identifier
user		string	User for auth
version		['string', 'null']	Version of the GNS3 remote server

Sample session

../../../examples/controller_post_servers.txt