gns3-server/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst

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

GET /v2/compute/projects/{project_id}/cloud/nodes/{node_id}

Get a cloud instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 200: Success
• 400: Invalid request
• 404: Instance doesn't exist

Output

Name	Mandatory	Type	Description
interfaces		array
name		string	Cloud name
node_id		string	Node UUID
ports		array
project_id		string	Project UUID
status		enum	Possible values: started, stopped, suspended

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

Update a cloud 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

Types

EthernetInterfacePort

Ethernet interface port

Name	Mandatory	Type	Description
interface	✔	string	Ethernet interface name e.g. eth0
name	✔	string	Port name
port_number	✔	integer	Port number
type	✔	enum	Possible values: ethernet

HostInterfaces

Interfaces on this host

Name	Mandatory	Type	Description
name	✔	string	Interface name
type	✔	enum	Possible values: ethernet, tap

TAPInterfacePort

TAP interface port

Name	Mandatory	Type	Description
interface	✔	string	TAP interface name e.g. tap0
name	✔	string	Port name
port_number	✔	integer	Port number
type	✔	enum	Possible values: tap

UDPTunnelPort

UDP tunnel port

Name	Mandatory	Type	Description
lport	✔	integer	Local UDP tunnel port
name	✔	string	Port name
port_number	✔	integer	Port number
rhost	✔	string	Remote UDP tunnel host
rport	✔	integer	Remote UDP tunnel port
type	✔	enum	Possible values: udp

Body

Name	Mandatory	Type	Description
interfaces		array
name		string	Cloud name
node_id		string	Node UUID
ports		array
project_id		string	Project UUID
status		enum	Possible values: started, stopped, suspended

Output

Name	Mandatory	Type	Description
interfaces		array
name		string	Cloud name
node_id		string	Node UUID
ports		array
project_id		string	Project UUID
status		enum	Possible values: started, stopped, suspended

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

Delete a cloud instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

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