gns3-server/docs/api/v2/compute/docker/projectsprojectiddockernodes.rst

/v2/compute/projects/{project_id}/docker/nodes

POST /v2/compute/projects/{project_id}/docker/nodes

Create a new Docker container

Parameters

• project_id: Project UUID

Response status codes

• 201: Instance created
• 400: Invalid request
• 409: Conflict

Input

Name	Mandatory	Type	Description
adapters		['integer', 'null']	Number of adapters
aux		['integer', 'null']	Auxiliary TCP port
console		['integer', 'null']	Console TCP port
console_http_path		string	Path of the web interface
console_http_port		integer	Internal port in the container for the HTTP server
console_resolution		['string', 'null']	Console resolution for VNC
console_type		enum	Possible values: telnet, vnc, http, https, none
container_id		string	Docker container ID Read only
custom_adapters		array
environment		['string', 'null']	Docker environment variables
extra_hosts		['string', 'null']	Docker extra hosts (added to /etc/hosts)
extra_volumes		array	Additional directories to make persistent
image	✔	string	Docker image name
name	✔	string	Docker container name
node_id		string	Node UUID
start_command		['string', 'null']	Docker CMD entry
usage		string	How to use the Docker container

Output

Name	Mandatory	Type	Description
adapters		['integer', 'null']	number of adapters
aux		integer	Auxiliary TCP port
console		['integer', 'null']	Console TCP port
console_http_path		string	Path of the web interface
console_http_port		integer	Internal port in the container for the HTTP server
console_resolution		string	Console resolution for VNC
console_type		enum	Possible values: telnet, vnc, http, https, none
container_id		string	Docker container ID Read only
custom_adapters		array
environment		['string', 'null']	Docker environment
extra_hosts		['string', 'null']	Docker extra hosts (added to /etc/hosts)
extra_volumes		array	Additional directories to make persistent
image		string	Docker image name Read only
name		string	Docker container name
node_directory		string	Path to the node working directory Read only
node_id		string	Node UUID
project_id		string	Project UUID Read only
start_command		['string', 'null']	Docker CMD entry
status		enum	Possible values: started, stopped, suspended
usage		string	How to use the Docker container