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

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

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

Delete a Docker container

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 400: Invalid request
• 404: Instance doesn't exist
• 204: Instance deleted

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

Update a Docker instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 200: Instance updated
• 400: Invalid request
• 404: Instance doesn't exist
• 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
environment		['string', 'null']	Docker environment variables
name		string	Docker container name
start_command		['string', 'null']	Docker CMD entry

Output

Name	Mandatory	Type	Description
adapters	✔	['integer', 'null']	number of adapters
aux	✔	integer	Auxiliary TCP port
console	✔	integer	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
container_id	✔	string	Docker container ID
environment	✔	['string', 'null']	Docker environment
image	✔	string	Docker image name
name		string	Docker container name
node_directory	✔	string	Path to the node working directory
node_id	✔	string	Node UUID
project_id	✔	string	Project UUID
start_command	✔	['string', 'null']	Docker CMD entry
status	✔	enum	Possible values: started, stopped, suspended

Sample session

../../../examples/compute_put_projectsprojectiddockernodesnodeid.txt