gns3-server/docs/api/v1/docker/projectsprojectiddockerimagesidstop.rst

/v1/projects/{project_id}/docker/images/{id}/stop

POST /v1/projects/{project_id}/docker/images/{id}/stop

Stop a Docker container

Parameters

• id: ID of the container
• project_id: UUID of the project

Response status codes

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

Input

Name	Mandatory	Type	Description
adapter_type		string	Docker adapter type
adapters		integer	number of adapters
console		string	console name
imagename		string	Docker image name
name		string	Docker container name
startcmd		string	Docker CMD entry
vm_id			Docker VM instance identifier

Output

Name	Mandatory	Type	Description
adapter_type		string	Docker adapter type
adapters		integer	number of adapters
cid		string	Docker container ID
image		string	Docker image name
name		string	Docker container name
project_id	✔	string	Project UUID
vm_id	✔	string	Docker container instance UUID