API Detail - Revision history

Favyen Bastani: /* Create */

2015-05-23T15:12:41Z

‎Create

Favyen Bastani: /* Examples */

2015-05-23T15:12:26Z

‎Examples

Favyen Bastani: /* Floating IP management */

2015-05-23T04:25:54Z

‎Floating IP management

Favyen Bastani at 04:24, 23 May 2015

2015-05-23T04:24:41Z

Favyen Bastani: /* Floating IP management */

2015-05-23T04:24:22Z

‎Floating IP management

Favyen Bastani at 04:24, 23 May 2015

2015-05-23T04:24:04Z

Favyen Bastani: /* Basic Operations */

2015-05-23T04:14:00Z

‎Basic Operations

Favyen Bastani: /* Examples */

2015-05-23T04:05:39Z

‎Examples

Favyen Bastani: Created page with "This page includes details about the available API actions. See [API] to get started. Each action has a category and an action identifier, and can also accept some parameters..."

2015-05-23T04:05:29Z

Created page with "This page includes details about the available API actions. See [API] to get started. Each action has a category and an action identifier, and can also accept some parameters..."

New page

This page includes details about the available API actions. See [API] to get started.

Each action has a category and an action identifier, and can also accept some parameters.

== Virtual Machine ==

Virtual machine actions have the "vm" category, and allow you to provision and manage virtual machine instances.

=== Basic Operations ===

==== Actions ====

* start: boot the VM
* stop: shutoff the VM
* reboot: soft reboot the VM
* info: show VM details
* delete: remove VM
* rescue: boot VM to initial OS
* vnc: get VNC URL

==== Parameters ====

All basic operations take a single vm_id parameter.

==== Examples ====

<nowiki>
api.request('vm', 'start', {'vm_id': 55}) # boot VM with id=55
print api.request('vm', 'vnc', {'vm_id': 56})['vnc_url'] # print VNC URL for this VM
print api.request('vm', 'info', {'vm_id': 56})['info']['primaryip'] # print VM id=56 primary IP
</nowiki>

@@ Line 46: / Line 46: @@
 ** scripts: comma-separated list of startup script IDs to apply on this VM
 ** set_password: if this key is set, the panel will send a cloud-config startup script to try and set a password for the image's administrative user; the password will be available from info under login_details
   <nowiki>

@@ Line 50: / Line 50: @@
   <nowiki>
-api.request('vm', 'create', {'hostname': 'myvm', 'plan_id': 1, 'image_id': 26}) # create a new 512 MB instance with Ubuntu 14.04 64-bit template image
+# create a new 512 MB instance with Ubuntu 14.04 64-bit template image
-api.request('vm', 'create', {'hostname': 'myvm', 'plan_id': 1, 'volume_id': 311, 'scripts': '99,100'}) # also use some security groups and boot from a volume</nowiki>
+api.request('vm', 'create', {'hostname': 'myvm', 'plan_id': 1, 'image_id': 26})
 === List ===

@@ Line 71: / Line 71: @@
 # pick first VM on account and de-associate its floating IP, keep the IP on account
 vm_id = api.request('vm', 'list')['vms'][0]['vm_id']
-api.request('vm', 'floatingip-add', {'vm_id': vm_id, 'keep': 'yes'})
+api.request('vm', 'floatingip-add', {'vm_id': vm_id, 'keep': 'yes'})</nowiki>
 </nowiki>

← Older revision		Revision as of 04:24, 23 May 2015
Line 1:		Line 1:
−	This page includes details about the available API actions. See [API] to get started.	+	This page includes details about the available API actions. See [[API]] to get started.

	Each action has a category and an action identifier, and can also accept some parameters. Below, whenever single quotes are used (e.g. 'example'), you should not include the quotes in the actual API call.		Each action has a category and an action identifier, and can also accept some parameters. Below, whenever single quotes are used (e.g. 'example'), you should not include the quotes in the actual API call.

@@ Line 72: / Line 72: @@
 vm_id = api.request('vm', 'list')['vms'][0]['vm_id']
 api.request('vm', 'floatingip-add', {'vm_id': vm_id, 'keep': 'yes'})
-<nowiki>
+</nowiki>

@@ Line 1: / Line 1: @@
 This page includes details about the available API actions. See [API] to get started.
-Each action has a category and an action identifier, and can also accept some parameters.
+Each action has a category and an action identifier, and can also accept some parameters. Below, whenever single quotes are used (e.g. 'example'), you should not include the quotes in the actual API call.
 == Virtual Machine ==
@@ Line 40: / Line 40: @@
 ** region: 'toronto' or 'montreal'
 ** key_id: ID of an [https://dynamic.lunanode.com/panel/key.php SSH key]
-** prefer: either 'distinct' or 'same' (without quotes), to indicate whether we should try to provision VM on the same host node or a different host node
+** prefer: either 'distinct' or 'same', to indicate whether we should try to provision VM on the same host node or a different host node
 ** net_id: ID number of a [https://dynamic.lunanode.com/panel/networks.php virtual network]
 ** ip: floating IP address already on your account to use to provision the VM (e.g. 38.110.116.1)
@@ Line 46: / Line 46: @@
 ** scripts: comma-separated list of startup script IDs to apply on this VM
 ** set_password: if this key is set, the panel will send a cloud-config startup script to try and set a password for the image's administrative user; the password will be available from info under login_details

← Older revision		Revision as of 04:14, 23 May 2015
Line 29:		Line 29:
	print api.request('vm', 'vnc', {'vm_id': 56})['vnc_url'] # print VNC URL for this VM		print api.request('vm', 'vnc', {'vm_id': 56})['vnc_url'] # print VNC URL for this VM
	print api.request('vm', 'info', {'vm_id': 56})['info']['primaryip'] # print VM id=56 primary IP</nowiki>		print api.request('vm', 'info', {'vm_id': 56})['info']['primaryip'] # print VM id=56 primary IP</nowiki>
		+
		+	=== Create ===
		+
		+	* Action identifier: create
		+	* Required parameters:
		+	** hostname: name for the VM, like "myvm.example.com" or just "myvm"
		+	** plan_id: ID number of the plan to use (see plan/list action)
		+	** image_id/volume_id: ID number of image or volume to boot VM from (see image/list and volume/list actions)
		+	* Optional parameters:
		+	** region: 'toronto' or 'montreal'
		+	** key_id: ID of an [https://dynamic.lunanode.com/panel/key.php SSH key]
		+	** prefer: either 'distinct' or 'same' (without quotes), to indicate whether we should try to provision VM on the same host node or a different host node
		+	** net_id: ID number of a [https://dynamic.lunanode.com/panel/networks.php virtual network]
		+	** ip: floating IP address already on your account to use to provision the VM (e.g. 38.110.116.1)
		+	** securitygroups: comma-separated list of security group IDs to apply on this VM
		+	** scripts: comma-separated list of startup script IDs to apply on this VM
		+	** set_password: if this key is set, the panel will send a cloud-config startup script to try and set a password for the image's administrative user; the password will be available from info under login_details

@@ Line 28: / Line 28: @@
 api.request('vm', 'start', {'vm_id': 55}) # boot VM with id=55
 print api.request('vm', 'vnc', {'vm_id': 56})['vnc_url'] # print VNC URL for this VM
-print api.request('vm', 'info', {'vm_id': 56})['info']['primaryip'] # print VM id=56 primary IP
+print api.request('vm', 'info', {'vm_id': 56})['info']['primaryip'] # print VM id=56 primary IP</nowiki>
 </nowiki>