API - Revision history

Favyen Bastani at 23:15, 17 December 2018

2018-12-17T23:15:53Z

Favyen Bastani: /* Startup scripts */

2017-12-06T02:47:09Z

‎Startup scripts

Favyen Bastani: /* DNS */

2017-04-17T00:25:06Z

‎DNS

Favyen Bastani: /* DNS */

2017-04-17T00:24:16Z

‎DNS

Favyen Bastani: /* DNS */

2017-04-17T00:23:38Z

‎DNS

Favyen Bastani: /* DNS */

2017-04-17T00:23:26Z

‎DNS

Favyen Bastani: /* Legacy DNS */

2017-04-17T00:23:11Z

‎Legacy DNS

Favyen Bastani: /* DNS */

2017-04-17T00:13:53Z

‎DNS

Favyen Bastani: /* Volume */

2017-03-19T20:07:06Z

‎Volume

Favyen Bastani: /* Volume */

2017-03-19T20:06:43Z

‎Volume

← Older revision		Revision as of 23:15, 17 December 2018
Line 1:		Line 1:
		+	'''For the latest API documentation, refer to https://www.lunanode.com/api/overview'''
		+
	The Luna Node Dynamic API enables you to write software to automate VM management. This page details how the API can be accessed. Visit the [https://dynamic.lunanode.com/panel/api API tab] to manage your API keys.		The Luna Node Dynamic API enables you to write software to automate VM management. This page details how the API can be accessed. Visit the [https://dynamic.lunanode.com/panel/api API tab] to manage your API keys.

@@ Line 719: / Line 719: @@
 |list
 |None
 |None
 |}

@@ Line 294: / Line 294: @@
 Here are details for parameters to the '''record-add''' action:
-* name: e.g. 'blah' or 'blah.example.com.' for 'blah.example.com.'
+* '''name''': e.g. 'blah' or 'blah.example.com.' for 'blah.example.com.'
-* data: the record contents, e.g. '1.2.3.4' for an A record or 'other.example.org.' for a CNAME/MX record
+* '''data''': the record contents, e.g. '1.2.3.4' for an A record or 'other.example.org.' for a CNAME/MX record
-* ttl: time-to-live, e.g. 3600
+* '''ttl''': time-to-live, e.g. 3600
-* type: one of 'A', 'AAAA', 'CNAME', 'ALIAS', 'MX', 'NS', 'TXT', 'SPF', 'SRV'
+* '''type''': one of 'A', 'AAAA', 'CNAME', 'ALIAS', 'MX', 'NS', 'TXT', 'SPF', 'SRV'
-* policy (optional): geo-targeting policy, 'none' for no geo-targeting, 'latlong' to route to record with closest latitude/longitude to the user's location, and 'region' for hierarchical region-based routing
+* '''policy (optional)''': geo-targeting policy, 'none' for no geo-targeting, 'latlong' to route to record with closest latitude/longitude to the user's location, and 'region' for hierarchical region-based routing
-* weight (optional): the record weight (this is used for load balancing or non-round-robin DNS failover)
+* '''weight (optional)''': the record weight (this is used for load balancing or non-round-robin DNS failover)
-* region, regiongroup, country, continent, global (optional): parameters for hierarchical region-based routing, see the UI for details (set global to 'no' to disable for global group)
+* '''region, regiongroup, country, continent, global (optional)''': parameters for hierarchical region-based routing, see the UI for details (set global to 'no' to disable for global group)
-* latitude, longitude (optional): latitude/longitude for 'latlong' policy
+* '''latitude, longitude (optional)''': latitude/longitude for 'latlong' policy
-* aux: priority for certain record types, such as MX and SRV
+* '''aux (optional)''': priority for certain record types, such as MX and SRV
-* monitor_id: the ID of a monitor check (see monitor.check-list action), this record will be disabled if the check fails
+* '''monitor_id (optional)''': the ID of a monitor check (see monitor.check-list action), this record will be disabled if the check fails
-* orig_record_id: update an existing record with the specified ID instead of creating a new record
+* '''orig_record_id (optional)''': update an existing record with the specified ID instead of creating a new record
 === Legacy DNS ===

@@ Line 282: / Line 282: @@
 |-
 |dns2
-|zone-add
+|record-add
 |zone_id, name, data, ttl, type
 |policy, weight, region, regiongroup, country, continent, global, latitude, longitude, aux, monitor_id, orig_record_id
@@ Line 292: / Line 292: @@
 |}
-Here are details for parameters to the '''zone-add''' action:
+Here are details for parameters to the '''record-add''' action:
 * name: e.g. 'blah' or 'blah.example.com.' for 'blah.example.com.'

@@ Line 290: / Line 290: @@
 |zone_id, record_id
 |None
+|}
 Here are details for parameters to the '''zone-add''' action:

← Older revision		Revision as of 00:23, 17 April 2017
Line 250:		Line 250:

	Note: for create command, net_id is a network ID number, securitygroups is a comma-separated list of security group ID numbers, scripts is a comma-separated list of script ID numbers, volume_id is the ID number of an unattached volume that the new VM should be booted from (if volume_id is set, image_id is not required), and affinity_group is an affinity group UUID. Also, if volume_id is set, then the driver is ide if volume_virtio is not set, or virtio of volume_virtio is set (value of volume_virtio is ignored). Finally, key_id is an [https://dynamic.lunanode.com/panel/key SSH keypair ID], and set_password can be set if you want the system to add a startup script to set a randomly generated password (this is ignored if key_id is set; also, the system will set password by default for official templates).		Note: for create command, net_id is a network ID number, securitygroups is a comma-separated list of security group ID numbers, scripts is a comma-separated list of script ID numbers, volume_id is the ID number of an unattached volume that the new VM should be booted from (if volume_id is set, image_id is not required), and affinity_group is an affinity group UUID. Also, if volume_id is set, then the driver is ide if volume_virtio is not set, or virtio of volume_virtio is set (value of volume_virtio is ignored). Finally, key_id is an [https://dynamic.lunanode.com/panel/key SSH keypair ID], and set_password can be set if you want the system to add a startup script to set a randomly generated password (this is ignored if key_id is set; also, the system will set password by default for official templates).
		+
		+	=== DNS ===
		+
		+	API calls relating to DNS are listed below (see next section for Legacy DNS).
		+
		+	{\| class="wikitable"
		+	! Category
		+	! Action
		+	! Required parameters
		+	! Optional parameters
		+	\|-
		+	\|dns2
		+	\|zone-list
		+	\|None
		+	\|None
		+	\|-
		+	\|dns2
		+	\|zone-add
		+	\|name (e.g. 'example.com'), ttl
		+	\|None
		+	\|-
		+	\|dns2
		+	\|zone-remove
		+	\|zone_id
		+	\|None
		+	\|-
		+	\|dns2
		+	\|record-list
		+	\|zone_id
		+	\|None
		+	\|-
		+	\|dns2
		+	\|zone-add
		+	\|zone_id, name, data, ttl, type
		+	\|policy, weight, region, regiongroup, country, continent, global, latitude, longitude, aux, monitor_id, orig_record_id
		+	\|-
		+	\|dns2
		+	\|record-remove
		+	\|zone_id, record_id
		+	\|None
		+
		+	Here are details for parameters to the '''zone-add''' action:
		+
		+	* name: e.g. 'blah' or 'blah.example.com.' for 'blah.example.com.'
		+	* data: the record contents, e.g. '1.2.3.4' for an A record or 'other.example.org.' for a CNAME/MX record
		+	* ttl: time-to-live, e.g. 3600
		+	* type: one of 'A', 'AAAA', 'CNAME', 'ALIAS', 'MX', 'NS', 'TXT', 'SPF', 'SRV'
		+	* policy (optional): geo-targeting policy, 'none' for no geo-targeting, 'latlong' to route to record with closest latitude/longitude to the user's location, and 'region' for hierarchical region-based routing
		+	* weight (optional): the record weight (this is used for load balancing or non-round-robin DNS failover)
		+	* region, regiongroup, country, continent, global (optional): parameters for hierarchical region-based routing, see the UI for details (set global to 'no' to disable for global group)
		+	* latitude, longitude (optional): latitude/longitude for 'latlong' policy
		+	* aux: priority for certain record types, such as MX and SRV
		+	* monitor_id: the ID of a monitor check (see monitor.check-list action), this record will be disabled if the check fails
		+	* orig_record_id: update an existing record with the specified ID instead of creating a new record

	=== Legacy DNS ===		=== Legacy DNS ===

@@ Line 251: / Line 251: @@
 Note: for create command, net_id is a network ID number, securitygroups is a comma-separated list of security group ID numbers, scripts is a comma-separated list of script ID numbers, volume_id is the ID number of an unattached volume that the new VM should be booted from (if volume_id is set, image_id is not required), and affinity_group is an affinity group UUID. Also, if volume_id is set, then the driver is ide if volume_virtio is not set, or virtio of volume_virtio is set (value of volume_virtio is ignored). Finally, key_id is an [https://dynamic.lunanode.com/panel/key SSH keypair ID], and set_password can be set if you want the system to add a startup script to set a randomly generated password (this is ignored if key_id is set; also, the system will set password by default for official templates).
-=== DNS ===
+=== Legacy DNS ===
-API calls relating to DNS are listed below. Valid DNS record types are 'A', 'AAAA', 'CNAME', 'HINFO', 'MX', 'NAPTR', 'NS', 'PTR', 'RP', 'SRV', and 'TXT'.
+API calls relating to Legacy DNS are listed below. Valid DNS record types are 'A', 'AAAA', 'CNAME', 'HINFO', 'MX', 'NAPTR', 'NS', 'PTR', 'RP', 'SRV', and 'TXT'.
 {| class="wikitable"

@@ Line 428: / Line 428: @@
 |volume
 |snapshot-replicate
-|region, snapshot_id, image_name, dst_region
+|region, snapshot_id, image_name (e.g. 'myimage'), dst_region (e.g. 'toronto')
 |None
 |-

@@ Line 424: / Line 424: @@
 |snapshot-list
 |region
 |None
 |-